Sign in

v3

OpenAPI 3.1.02026-07-2759128137.8 KB
activities

List Activities

List activities recorded in the workspace.

Requires the activities:read scope on the API key.

get/v1/activities

Query parameters

pageinteger

Page number.

Page number.

sizeinteger

Number of items per page.

Number of items per page.

sort_by'created_at'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

contact_idstring uuid nullable

Filter by contact.

Filter by contact.

sequence_idstring uuid nullable

Filter by sequence run.

Filter by sequence run.

sequence_template_idstring uuid nullable

Filter by sequence template.

Filter by sequence template.

resource_type'MESSAGE' | 'INVITATION' | 'HOT_LEAD' | 'MEETING' | 'SEQUENCE_STEP' | 'SEQUENCE' | 'TASK'

Filter by resource type.

channel'EMAIL' | 'LINKEDIN' | 'MANUAL'

Filter by channel.

event_type'SENT' | 'REPLIED' | 'OPENED' | 'LINK_CLICKED' | 'ACCEPTED' | 'CREATED' | 'PAUSED' | 'RESUMED' | 'STOPPED' | 'COMPLETED' | 'SKIPPED'

Filter by event type.

created_at_afterstring date-time nullable

Return activities strictly after this timestamp (exclusive).

Return activities strictly after this timestamp (exclusive).

created_at_beforestring date-time nullable

Return activities strictly before this timestamp (exclusive).

Return activities strictly before this timestamp (exclusive).

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.