getActionsByWorkspace

Query

workspaceId

The workspace ID to retrieve actions from

text

Search for actions that contain this text in the action title, description or other fields. Do NOT use this for action IDs - use 'specificIds' instead.

first = 25

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

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 IDs lookups rather than text searches.

assignees

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

labels

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

includeChildProjects

Filter actions by child projects

excludeCompletedActions = true

Exclude completed actions from the results. Defaults to 'true'

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

A start date for a given date range to filter actions results. Used to filter by date of completion or deadline/scheduled date.

endDate

An end date for a given date range to filter actions results. Used to filter by date of completion or deadline/scheduled date.

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

sortField = "rank"

The field to sort the actions by. Use only Action document field.

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.