latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Activity

Get Activity Logs

Get activity logs.

Returns a paginated list of activity events for the user. Events can be filtered by object type (project, item, note, section), event type, and other criteria. Uses cursor-based pagination for efficient navigation through results.

get/api/v1/activities

Query parameters

object_type'project' | 'item' | 'note' | 'section' nullable

The type of object to filter activities by. Must be one of "project", "item" (task), "note" (comment), or "section". When specified with object_id, returns activities for that specific object.

Example:item
integer
OR
string
integer
OR
string
integer
OR
string
include_parent_objectboolean

When true and object_id is specified, also include activities for the parent object. For example, when filtering by a specific task, also include activities for its parent project.

include_child_objectsboolean

When true and object_id is specified, also include activities for all child objects. For example, when filtering by a project, also include activities for all its tasks and comments.

integer
OR
integer[]
initiator_id_nullboolean nullable

Filter by whether the activity has an initiator. When true, returns only activities with no initiator (your own activities). When false, returns only activities initiated by collaborators.

event_typestring nullable

Filter by a simple event type (e.g., "added", "deleted", "completed"). Returns events of this type across ALL object types that support it. Valid types: "added", "deleted", "updated", "archived", "unarchived", "completed", "uncompleted", "shared", "left", "moved". Prefix the value with ! to negate the filter and return all events EXCEPT this type (e.g., "!deleted"). For more precise filtering by both object type and event type, use object_event_types instead.

Example:added
ensure_last_stateboolean

Deprecated - This parameter has no implementation and will be removed in a future version.

object_event_typesstring[] nullable

Advanced filtering for specific object type and event type combinations. Format: ["object_type:event_type"]. Examples: ["item:deleted"] for deleted tasks, ["item:"] for all task events, [":deleted"] for all delete events across all types, ["item:deleted", "note:added"] for multiple filters. Valid event types: "added", "deleted", "updated", "completed", "uncompleted", "archived", "unarchived", "shared", "left", "moved". This is the recommended way to filter events.

[
  "item:deleted"
]
integer
OR
integer[]
annotate_notesboolean

When true, includes additional information about comments in the extra_data field, such as the content of the comment.

annotate_parentsboolean

When true, includes additional information about parent objects in the extra_data field, such as the name of the parent project or task.

cursorstring nullable

An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request

Example:14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55
limitinteger

The number of objects to return in a page

Example:50
date_fromstring date-time nullable

Filter activities to only those that occurred on or after this date. Must be in ISO 8601 format (e.g. '2026-01-01T00:00:00Z'). When specified, overrides the default pagination behavior and allows custom date ranges.

Example:2026-01-01
date_tostring date-time nullable

Filter activities to only those that occurred before this date (exclusive upper bound). Must be in ISO 8601 format (e.g. '2026-02-01T00:00:00Z'). When specified, overrides the default pagination behavior and allows custom date ranges.

Example:2026-02-01T00:00:00Z

Response

Successful Response

next_cursorstring nullable required

Cursor for the next page of results, or null when there are no more results.

Example response

{
  "results": [],
  "next_cursor": "14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55"
}