ATattio
Records

List records

Changed on

Lists people, company or other records, with the option to filter and sort results.

Required scopes: record_permission:read, object_configuration:read.

Supported token levels: workspace, user.

post/v2/objects/{object}/records/query

Request

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

Path parameters

objectstring required

A UUID or slug to identify the object to list records for.

Example:people

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.

filter_view_idstring uuid

UUID of a saved view on this object or list. When set, results are filtered using that view's filter configuration. Cannot be used together with filter. Note: sorts, limits, and offsets are applied independently and are not taken from the view. All attributes are returned regardless of which attributes are visible in the view.

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",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z",
      "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b"
    }
  ]
}

Changes

  • 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

  • 512470c1fc31Revision changes
    • warning

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