POST
/
v2
/
objects
/
{object}
/
records
/
query
curl --request POST \
  --url https://api.attio.com/v2/objects/{object}/records/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "name": "Ada Lovelace"
  },
  "sorts": [
    {
      "direction": "asc",
      "attribute": "name",
      "field": "last_name"
    }
  ],
  "limit": 500,
  "offset": 0
}'
{
  "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",
      "values": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

This API uses OAuth 2.0 with the authorization code grant flow.

Path Parameters

​
object
string
required

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

Example:

"people"

Body

application/json
​
filter
object

An object used to filter results to a subset of results. See the full guide to filtering and sorting here.

Example:
{ "name": "Ada Lovelace" }
​
sorts
object[]

An object used to sort results. See the full guide to filtering and sorting here.

Sort by attribute

Example:
[
  {
    "direction": "asc",
    "attribute": "name",
    "field": "last_name"
  }
]
​
limit
number

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

Example:

500

​
offset
number

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

Example:

0

Response

200
application/json

Success

​
data
object[]
required

Was this page helpful?