Object

Below is the data structure of the Action object in Hive:

Field

Type

Description

id

String

Unique alphanumeric string id

title

String

Title of the action

workspace

String/Workspace ID

ID of the Workspace that the Action belongs to

assignees

Array

Array of User ID strings. Array with value 'none' represents unassigned

projectId

String/Project ID

ID of the Project (if any) that the Action belongs to

description

String

User input description of the action

customFields

Array of objects
[{ label: '', value: '' }][{ label: '', value: '' }]

Action custom fields

createdAt

ISO Date String

Date + time of Action creation

modifiedAt

ISO Date String

Date + time that the Action was last modified

createdBy

String/User ID

User ID string of the Action creator

modifiedBy

String/User ID

User ID string of the last user to modify fields on the Action

status

String

Status of the action

scheduledDate

String

Start Date as Date ISO String

deadline

String

Due date as Date ISO String

parent

String/Action ID

Parent action the Action belongs to (if any)

root

String/Action ID

Highest-level action of a tree of actions

hasSubactions

Boolean

Whether the Action has subactions

estimate

Int32

Estimated time

loggedTime

Array of objects
[{userId:'',time:'',date:''}][{userId:'',time:'',date:''}]

Time logged to an action card

estimates

Array of objects
[{userId:'',time:''}][{userId:'',time:''}]

Estimated time per assignee

milestone

Boolean

Whether the Action is a milestone or not

phaseId

String

Id of phase

phaseName

String

Name of phase

archived

Boolean

Whether the action is archived or not

deleted

Boolean

Whether the action is deleted or not

checkedDate

ISO Date String

Date that the action was marked "Completed" or checked

completedBy

String/User ID

User ID of the user who marked the action "Completed" or checked last. Note that this may be different than the assignee.

placeholderAssignees

Array

Array of Placeholder ID strings. Empty array if no placeholder assignees set on an action. If placeholders assignees are set on an action, will be populated with Placeholder IDs as strings in the array.

agileStoryPoints

Number

Number of story points assigned to action

agileSprintId

String

Identifier of the agile sprint