Skip to main content

List crm activities

GET 

/v2/crm_activities

Fetches multiple crm activity records. The records can be filtered, paged, and sorted according to the respective parameters.

Request

Query Parameters

    ids integer[]

    IDs of crm activities to fetch.

    updated_at[gt] iso8601 string

    Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] iso8601 string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] iso8601 string

    Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] iso8601 string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    sort_by string

    Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at

    sort_direction string

    Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

    limit_paging_counts boolean

    Specifies whether the max limit of 10k records should be applied to pagination counts. Affects the total_count and total_pages data

Responses

Success

Schema
    id integer

    CrmActivity ID

    created_at date-time

    Datetime of when the crm activity was created

    updated_at date-time

    Datetime of when the crm activity was last updated

    subject string

    The subject field of the activity in your CRM

    description string

    The description field of the activity in your CRM

    crm_id string

    The ID of the activity in your CRM, if written to your CRM

    activity_type string

    The type of activity that is being recorded, if available. The values can change over time, but could be one of: email, phone, email reminder, inmail

    error string

    Information about why this crm activity failed to sync, if it did fail to sync. Failed activities will be automatically retried and may become successful in the future

    custom_crm_fields object

    Additional fields that are logged to your CRM, if mapped by the team at the time of writing to your CRM

    person object

    Person that this crm activity is for

    id integer
    _href string
    user object

    User that triggered this crm activity

    id integer
    _href string
Loading...