Sign in

v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-04-245712812.6 KB
Records

List records

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

Required scopes: record_permission:read, object_configuration:read.

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

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