Create a list
Creates a new list.
Once you have your list, add attributes to it using the Create attribute API, and add records to it using the Add records to list API.
New lists must specify which records can be added with the parent_object parameter which accepts either an object slug or an object ID. Permissions for the list are controlled with the workspace_access and workspace_member_access parameters.
Please note that new lists must have either workspace_access set to "full-access" or one or more element of workspace_member_access with a "full-access" level. It is also possible to receive a 403 billing error if your workspace is not on a plan that supports either advanced workspace or workspace member-level access for lists.
Required scopes: list_configuration:read-write.
curl --request POST \
--url https://api.attio.com/v2/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"name": "Enterprise Sales",
"api_slug": "enterprise_sales",
"parent_object": "people",
"workspace_access": "read-and-write",
"workspace_member_access": [
{
"workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
"level": "read-and-write"
}
]
}
}'{
"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.
Body
The human-readable name of the list.
"Enterprise Sales"
A unique, human-readable slug to access the list through API calls. Should be formatted in snake case.
"enterprise_sales"
A UUID or slug to identify the allowed object type for records added to this list.
"people"
The level of access granted to all members of the workspace for this list. Pass null to keep the list private and only grant access to specific workspace members.
full-access, read-and-write, read-only "read-and-write"
The level of access granted to specific workspace members for this list. Pass an empty array to grant 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"
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 POST \
--url https://api.attio.com/v2/lists \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"name": "Enterprise Sales",
"api_slug": "enterprise_sales",
"parent_object": "people",
"workspace_access": "read-and-write",
"workspace_member_access": [
{
"workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
"level": "read-and-write"
}
]
}
}'{
"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"
}
}