getActionsByWorkspace

Query

workspaceId

The workspace ID to retrieve actions from

text

Search action titles and descriptions. For title-only reports, filter returned titles. Use specificIds for action IDs.

githubBranchNames

Match any exact GitHub branch entry, such as hive-os:feat/example. Omit for no branch filter; an empty list matches nothing. Ignored when specificIds is provided.

first

Maximum number of actions to return (default: 25, max: 200)

last

before

after

Cursor for pagination - retrieve actions after this cursor

status

The status of the actions you are searching for. When searching for finished or completed actions be sure to use "Completed" since the status search is case sensitive.

archived

Find actions that are marked as archived

projectIds

An array of project IDs to filter actions by. Include the null literal to also return actions with no project. Example: [null, 'n7JHc2CsRcvKe4WRH']

excludeProjectIds

An array of project IDs to exclude from the results. Actions from these projects will not be returned.

specificIds

Specific action ids or simple ids. Use this parameter when users provide specific action IDs (17-character alphanumeric strings like 'n7JHc2CsRcvKe4WRH') or specific simple numeric IDs (positive integers). This ensures direct ID lookups rather than text searches.

assignees

The user IDs that are assigned to the actions you are searching for

followers

The user IDs that follow the actions you are searching for

labels

The label IDs that are assigned to the actions you are searching for

includeChildProjects

When true, also include actions from child (sub) projects of the specified projectIds. Set to true when the user asks for actions across a project and its subprojects. Defaults to true when not specified.

excludeCompletedActions = true

Exclude completed actions from the results. Defaults to 'true'. Ignored when specificIds is provided — actions are returned by ID regardless of completion status.

excludeSnoozedActions

Exclude snoozed actions from the results. Defaults to 'true' for 'my actions' queries to show only actionable items. Pass 'false' if user explicitly wants to see snoozed actions.

createdAtStart

A createdAtStart date for a given date range to filter actions results

createdAtEnd

A createdAtEnd date for a given date range to filter actions results

completedDateStart

Start of completed date range to filter actions by their completion date (checkedDate). Can be used independently or with completedDateEnd.

completedDateEnd

End of completed date range to filter actions by their completion date (checkedDate). Can be used independently or with completedDateStart.

startDate

Start of the completion-date range when status is Completed; otherwise deadline/scheduled-date range. For due-date reports across statuses, omit status and set excludeCompletedActions false, then filter the returned status and deadline.

endDate

End of the completion-date range when status is Completed; otherwise deadline/scheduled-date range.

includePrivate

Whether to include private actions in the results. This should be set to true by default unless otherwise specified by the user.

parent

Filter actions to only show subactions of a specific parent action

topLevelOnly

When true, return only top-level actions without a parent

sortField = "rank"

Stored Action field for cursor pagination. Text search with rank returns one relevance page; use _id for complete exports.

sortOrder = 1

The order to sort the actions by. Use -1 for descending order and 1 for ascending order

milestone

Flag to filter actions by milestone

customFieldId

The ID of a custom field to filter by. Must be used together with customFieldValue.

customFieldValue

The value to filter the custom field by. For text fields, pass the string value. For number fields, pass the numeric value as a string. For date fields, pass the ISO date string. For select/user/project fields, pass the selected value ID.

includeArchivedProjects

When true, project visibility for this query includes archived projects (e.g. time data on archived projects). Does not change the action-level archived filter; use the archived argument for that.

excludeDraftModeProjects

When true, omits actions whose project is in draft mode, matching how Hive views hide draft projects until they are published. Use this in automations that must only pick up actions from published projects. Ignored when specificIds is provided. Defaults to false.