activities

List Activities

Changed on

List activities recorded in the workspace.

Requires the activities:read scope on the API key.

get/v1/activities

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/activities
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

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.

sequence_idstring uuid nullable

Filter by sequence run.

sequence_template_idstring uuid nullable

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' | 'REOPENED'

Filter by event type.

created_at_afterstring date-time nullable

Return activities strictly after this timestamp (exclusive).

created_at_beforestring date-time nullable

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.

Changes

  • 92a861044719Revision changes
    • warning

      added the new EMAIL_CATCH_ALL enum value to the ////// response property for the response status

  • d5f19ee44bd8Revision changes
    • warning

      added the new MEMBER_DEACTIVATED enum value to the ////// response property for the response status