Get a list

curl --request GET \
  --url https://api.attio.com/v2/lists/{list} \
  --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"
  }
}

GET

lists

{list}

Get a list

curl --request GET \
  --url https://api.attio.com/v2/lists/{list} \
  --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

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.

Example:

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

Response

Success

data

object

required

Show child attributes

data.id

object

required

Show child attributes

data.id.workspace_id

string<uuid>

required

A UUID to identify the workspace this list belongs to.

Example:

"14beef7a-99f7-4534-a87e-70b564330a4c"

data.id.list_id

string<uuid>

required

A UUID to identify this list.

Example:

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

data.api_slug

string

required

A human-readable slug for use in URLs and responses.

Example:

"hiring-engineering"

data.name

string

required

The name of the list, as viewed in the UI.

Example:

"Hiring Engineering"

data.parent_object

string[]

required

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.

Example:

["people"]

data.workspace_access

enum<string> | null

required

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.

Available options:

full-access,

read-and-write,

read-only

Example:

"read-and-write"

data.workspace_member_access

object[]

required

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.

Show child attributes

data.workspace_member_access.workspace_member_id

string<uuid>

required

A UUID to identify the workspace member to grant access to.

Example:

"50cf242c-7fa3-4cad-87d0-75b1af71c57b"

data.workspace_member_access.level

enum<string>

required

The level of access to the list.

Available options:

full-access,

read-and-write,

read-only

Example:

"read-and-write"

data.created_by_actor

object

required

The actor which created this list.

Show child attributes

data.created_by_actor.id

string | null

An ID to identify the actor.

data.created_by_actor.type

enum<string> | null

The type of actor. Read more information on actor types here.

Available options:

api-token,

workspace-member,

system,

app

Example:

{
  "type": "workspace-member",
  "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}

data.created_at

string

required

When the list was created.

Example:

"2022-11-21T13:22:49.061281000Z"

Create a list Update a list

⌘I

Introduction

Guides

Tutorials

Endpoint reference

Webhook reference

Get a list

Authorizations

Path Parameters

Response