Sign in
Activity records

List activity records

Lists activity records, with the option to filter and sort results.

This endpoint is in alpha and may be subject to breaking changes as we gather feedback.

Required scopes: activity_record:read, activity_configuration:read.

post/v2/activities/{activity}/records/query

Path parameters

activitystring required

A UUID or slug to identify the activity.

Example:phone_calls

Request body

filterobject

An object used to filter results to a subset of results. Cannot be used together with filter_view_id. See the full guide to filtering and sorting here.

limitnumber

The maximum number of results to return. Defaults to 500. See the full guide to pagination here.

offsetnumber

The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

Example request

{
  "filter": {
    "name": "Ada Lovelace"
  },
  "sorts": [
    {
      "direction": "asc",
      "attribute": "name",
      "field": "last_name"
    }
  ],
  "limit": 500
}

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "activity_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "record_id": "5f4f2d9c-2b3e-4a83-9c76-1de3a3f14f26"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z"
    }
  ]
}

Changes