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

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.

Changes

Changed in 4 of the 12 revisions of this API.3143

    • added TaskReopenedPayload ContactEntryResolvedPayload EventResolvedPayload ContactExclusionCreatedPayload to the items/items/payload response property oneOf list for the response status 200

      response-property-one-of-added

    • added the enum value REOPENED to the property anyOf[subschema #1: ActivityEventType]/ of the query request parameter event_type

      request-parameter-property-enum-value-added

    • added contact_entry.resolved contact_exclusion.created event.resolved task.reopened discriminator mapping keys to the items/items/payload response property for the response status 200

      response-property-discriminator-mapping-added

    • added the optional property items/items/payload/oneOf[subschema #10: SequencePausedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #10: SequencePausedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #11: SequenceResumedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #11: SequenceResumedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #12: SequenceStoppedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #12: SequenceStoppedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #13: SequenceCompletedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #13: SequenceCompletedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #14: TaskCreatedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #14: TaskCreatedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #14: TaskCreatedPayload]/task to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #15: TaskCompletedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #15: TaskCompletedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #15: TaskCompletedPayload]/task to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #16: TaskSkippedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #16: TaskSkippedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #16: TaskSkippedPayload]/task to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #1: MessageSentPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #1: MessageSentPayload]/message to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #1: MessageSentPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #2: MessageOpenedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #2: MessageOpenedPayload]/message to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #2: MessageOpenedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #3: MessageLinkClickedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #3: MessageLinkClickedPayload]/message to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #3: MessageLinkClickedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #4: MessageRepliedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #4: MessageRepliedPayload]/message to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #4: MessageRepliedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #5: InvitationSentPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #5: InvitationSentPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #6: InvitationAcceptedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #6: InvitationAcceptedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #7: HotLeadCreatedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #7: HotLeadCreatedPayload]/hotLead to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #7: HotLeadCreatedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #8: MeetingCreatedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #8: MeetingCreatedPayload]/meeting to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #8: MeetingCreatedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #9: SequenceCreatedPayload]/contact to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/payload/oneOf[subschema #9: SequenceCreatedPayload]/sequenceTemplate to the response with the 200 status

      response-optional-property-added

    • the response property items/items/payload/oneOf[subschema #5: InvitationSentPayload]/metadata/stepNumber became optional for the status 200

      response-property-became-optional

    • response property items/items/payload/oneOf[subschema #5: InvitationSentPayload]/metadata/stepNumber list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added the new MISSING_CONTACT_DATA enum value to the items/items/payload/oneOf[subschema #12: SequenceStoppedPayload]/metadata/errorCode/anyOf[subschema #1: SequenceErrorCode]/ response property for the response status 200

      response-property-enum-value-added