Sign inStart for free
    1. Core Data
    2. /List

    List

    Lists are used to model a particular process. A List contains many Records in the form of Entries. Entries contain their own data from Attributes defined on the List and also data from their parent Record. Lists enforce that the Records they contain belong to a single Object type.

    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.

    Scopes

    • list_configuration:readrequired

    Response

    Status code

    Description

    Request

    GET
    /v2/lists
    curl https://api.attio.com/v2/lists \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {
      "data": [
        {
          "id": {
            "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
            "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
          },
          "name": "Hiring Engineering",
          "api_slug": "hiring-engineering",
          "created_at": "2022-11-21T13:22:49.061281000Z",
          "parent_object": [
            "people"
          ],
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "workspace_access": "read-and-write",
          "workspace_member_access": [
            {
              "level": "read-and-write",
              "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
            }
          ]
        }
      ]
    }

    Create a List

    Creates a new List. Once you have your List, add Attributes to it using the "Create Attribute" endpoint, and add Records to it using the "Add Records to List" endpoint. 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.

    Scopes

    • list_configuration:read-writerequired

    Request Body

    dataobject

    REQUIRED

    Response

    Status code

    Description

    Request

    POST
    /v2/lists
    curl https://api.attio.com/v2/lists \
      -H "Authorization: Bearer <token>" \
      -H "Content-Type: application/json" \
      -d @- << EOF
        {
          "data": {
            "name": "Enterprise Sales",
            "api_slug": "enterprise_sales",
            "parent_object": "people",
            "workspace_access": "read-and-write",
            "workspace_member_access": [
              {
                "level": "read-and-write",
                "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
              }
            ]
          }
        }
    EOF

    Response

    200 - Success

    {
      "data": {
        "id": {
          "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "name": "Hiring Engineering",
        "api_slug": "hiring-engineering",
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "parent_object": [
          "people"
        ],
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "workspace_access": "read-and-write",
        "workspace_member_access": [
          {
            "level": "read-and-write",
            "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          }
        ]
      }
    }

    Get a List

    Gets a single List in your Workspace that your Access Token has access to.

    Scopes

    • list_configuration:readrequired

    Path params

    liststring

    REQUIRED

    A UUID or slug to identify the List.

    Response

    Status code

    Description

    Request

    GET
    /v2/lists/:list
    curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0 \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {
      "data": {
        "id": {
          "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "name": "Hiring Engineering",
        "api_slug": "hiring-engineering",
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "parent_object": [
          "people"
        ],
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "workspace_access": "read-and-write",
        "workspace_member_access": [
          {
            "level": "read-and-write",
            "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          }
        ]
      }
    }

    Update a List

    Updates an existing List. Permissions for the List are controlled with the workspace_access and workspace_member_access parameters. Please note that 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. Changing the parent Object of a List is not possible through the API as it can have unintended side-effects that should be considered carefully. If you wish to carry out a parent Object change you should do so through the UI.

    Scopes

    • list_configuration:read-writerequired

    Path params

    liststring

    REQUIRED

    A UUID or slug to identify the List to update.

    Request Body

    dataobject

    REQUIRED

    Response

    Status code

    Description

    Request

    PATCH
    /v2/lists/:list
    curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0 \
      -H "Authorization: Bearer <token>" \
      -H "Content-Type: application/json" \
      -X PATCH \
      -d @- << EOF
        {
          "data": {
            "name": "Enterprise Sales",
            "api_slug": "enterprise_sales",
            "workspace_access": "read-and-write",
            "workspace_member_access": [
              {
                "level": "read-and-write",
                "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
              }
            ]
          }
        }
    EOF

    Response

    200 - Success

    {
      "data": {
        "id": {
          "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "name": "Hiring Engineering",
        "api_slug": "hiring-engineering",
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "parent_object": [
          "people"
        ],
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "workspace_access": "read-and-write",
        "workspace_member_access": [
          {
            "level": "read-and-write",
            "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
          }
        ]
      }
    }
    Terms & conditionsPrivacy policySecurity