ATattio
Activity records

List activity records

Changed on

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

This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.

Required scopes: activity_record:read, activity_configuration:read, object_configuration:read, record_permission:read.

Supported token levels: workspace, user.

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

Request

  • Base URL
    https://api.attio.com
  • URL
    https://api.attio.com/v2/activities/{activity}/records/query
  • Auth
    OAuth 2
    Authorization code: https://app.attio.com/authorize
    Token URL: https://app.attio.com/oauth/token scopes: activity_record:read, activity_configuration:read, object_configuration:read, record_permission:read

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

  • 623c79a2e7bfRevision changes
    • info

      the security scope object_configuration:read was added to the endpoint's security scheme oauth2

    • info

      the security scope record_permission:read was added to the endpoint's security scheme oauth2

  • 512a93f0f5edRevision changes
    • info

      removed the call enum value from the ////// response property for the response status

    • info

      removed the chat-thread enum value from the ////// response property for the response status

    • info

      removed the in-person-meeting enum value from the ////// response property for the response status