List entries
Lists entries in a given list, with the option to filter and sort results.
Required scopes: list_entry:read
, list_configuration:read
.
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
This API uses OAuth 2.0 with the authorization code grant flow.
Path Parameters
A UUID or slug to identify the list to retrieve entries from.
"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
Body
An object used to filter results to a subset of results. See the full guide to filtering and sorting here.
{ "name": "Ada Lovelace" }
An object used to sort results. See the full guide to filtering and sorting here.
Sort by attribute
[
{
"direction": "asc",
"attribute": "name",
"field": "last_name"
}
]
The maximum number of results to return. Defaults to 500. See the full guide to pagination here.
500
The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.
0
Response
Success
A UUID identifying the workspace this entry belongs to.
"14beef7a-99f7-4534-a87e-70b564330a4c"
A UUID identifying the list this entry is in.
"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
A UUID identifying this entry.
"2e6e29ea-c4e0-4f44-842d-78a891f8c156"
A UUID identifying the record that is parent of the list entry.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
A UUID or slug identifying the object that the parent record belongs to.
"people"
When this entry was created.
"2022-11-21T13:22:49.061281000Z"
A list of attribute values for the list entry (not attribute values for its parent record).
The point in time at which this value was made "active". active_from
can be considered roughly analogous to created_at
.
"2023-01-01T15:00:00.000000000Z"
The point in time at which this value was deactivated. If null
, the value is active.
"2023-01-01T15:00:00.000000000Z"
The actor that created this value.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token
, workspace-member
, system
, app
{
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
The type of the referenced actor. Read more information on actor types here.
api-token
, workspace-member
, system
, app
"workspace-member"
The ID of the referenced actor.
"50cf242c-7fa3-4cad-87d0-75b1af71c57b"
The attribute type of the value.
actor-reference
"actor-reference"
{
"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"
}
]
}
Was this page helpful?
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"
}
]
}
}
]
}