Skip to main content
POST
/
v2
/
lists
/
{list}
/
entries
/
query
List entries
curl --request POST \
  --url https://api.attio.com/v2/lists/{list}/entries/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",
        "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
        "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156"
      },
      "parent_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d",
      "parent_object": "people",
      "created_at": "2022-11-21T13:22:49.061281000Z",
      "entry_values": {
        "status": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "workspace-member",
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
            },
            "status": {
              "id": {
                "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
                "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
                "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b",
                "status_id": "527def35-7994-4ef7-9584-80ef8de352a8"
              },
              "title": "In Progress",
              "is_archived": false,
              "target_time_in_status": null,
              "celebration_enabled": false
            },
            "attribute_type": "status"
          }
        ],
        "created_at": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "workspace-member",
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
            },
            "value": "2023-01-01T15:00:00.000000000Z",
            "attribute_type": "timestamp"
          }
        ],
        "created_by": [
          {
            "active_from": "2023-01-01T15:00:00.000000000Z",
            "active_until": null,
            "created_by_actor": {
              "type": "workspace-member",
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
            },
            "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "referenced_actor_type": "workspace-member",
            "attribute_type": "actor-reference"
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
list
string
required

A UUID or slug to identify the list to retrieve entries from.

Example:

"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"

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

Success

Success

​
data
object[]
required