Introduction
How-to guides
Endpoint reference
- Core endpoints
- Objects
- Attributes
- Records
- Lists
- Entries
- Workspace members
- Notes
- Tasks
- Threads
- Comments
- Webhooks
- Meta
- Standard objects
- OAuth 2.0
List all lists
List all lists that your access token has access to. lists are returned in the order that they are sorted in the sidebar.
Required scopes: list_configuration:read.
curl --request GET \
--url https://api.attio.com/v2/lists \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
},
"api_slug": "hiring-engineering",
"name": "Hiring Engineering",
"parent_object": [
"people"
],
"workspace_access": "read-and-write",
"workspace_member_access": [
{
"workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
"level": "read-and-write"
}
],
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
]
}Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Response
Success
A human-readable slug for use in URLs and responses.
"hiring-engineering"
The name of the list, as viewed in the UI.
"Hiring Engineering"
A UUID or slug to identify the allowed object type for records added to this list. All new Lists are expected to have exactly one parent object. However, some legacy lists may have multiple allowed parents so the return type of this field is an array.
["people"]
The level of access granted to all members of the workspace for this list. null values represent a private list that only grants access to specific workspace members via the workspace_member_access property.
full-access, read-and-write, read-only "read-and-write"
The level of access granted to specific workspace members for this list. An empty array represents a list that has granted access to no workspace members.
A UUID to identify the workspace member to grant access to.
"50cf242c-7fa3-4cad-87d0-75b1af71c57b"
The level of access to the list.
full-access, read-and-write, read-only "read-and-write"
The actor which created this list.
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"
}
When the list was created.
"2022-11-21T13:22:49.061281000Z"
Was this page helpful?
curl --request GET \
--url https://api.attio.com/v2/lists \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
},
"api_slug": "hiring-engineering",
"name": "Hiring Engineering",
"parent_object": [
"people"
],
"workspace_access": "read-and-write",
"workspace_member_access": [
{
"workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
"level": "read-and-write"
}
],
"created_by_actor": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2022-11-21T13:22:49.061281000Z"
}
]
}