POST
/
v2
/
objects
/
workspaces
/
records
/
query
curl --request POST \
  --url https://api.attio.com/v2/objects/workspaces/records/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "$and": [
      {
        "workspace_id": {
          "value": {
            "$eq": "123"
          }
        }
      }
    ]
  },
  "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": {
        "workspace_id": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "value": "123",
            "attribute_type": "text"
          }
        ],
        "name": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "value": "Fundstack",
            "attribute_type": "text"
          }
        ],
        "users": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "users",
            "target_record_id": "5e3fb280-007b-495a-a530-9354bde01de1",
            "attribute_type": "record-reference"
          }
        ],
        "company": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "target_object": "companies",
            "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",
            "attribute_type": "record-reference"
          }
        ],
        "avatar_url": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "system",
              "id": null
            },
            "value": "https://example.com/avatar.png",
            "attribute_type": "text"
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
filter
object

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

Example:
{
  "$and": [
    {
      "workspace_id": { "value": { "$eq": "123" } }
    }
  ]
}
​
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