Core Data
/Entry

Entry

Entries are elements in a List that reference a single parent Record. Entries contain their own data from Attributes defined on the List and also data from their parent Record.

List Entries

Lists Entries in a given List, with the option to filter and sort results.

Scopes

list_entry:readrequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug to identify the List to retrieve Entries from.

Request Body

limitnumber

The maximum number of results to return. Defaults to 500 See the full guide to pagination here.

sortslist

An object used to sort results. See the full guide to filtering and sorting here.

Each item in the list is one of the types described below.

filterobject

An object used to filter results to a subset of records. See the full guide to filtering and sorting here.

offsetnumber

The number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.

Response

Status code

Description

Request

POST

/v2/lists/:list/entries/query

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/entries/query \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @- << EOF
    {
      "limit": 10,
      "sorts": [
        {
          "field": "last_name",
          "attribute": "name",
          "direction": "asc"
        }
      ],
      "filter": {
        "name": "Ada Lovelace"
      },
      "offset": 0
    }
EOF

Response

200 - Success

{
  "data": [
    {
      "id": {
        "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
        "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z",
      "entry_values": {
        "actor_reference_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "actor-reference",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "referenced_actor_type": "workspace-member"
          }
        ],
        "checkbox_slug_example": [
          {
            "value": true,
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "checkbox",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "currency_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "currency_code": "USD",
            "attribute_type": "currency",
            "currency_value": 99,
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "date_slug_example": [
          {
            "value": "2022-11-21T13:22:49.061281000Z",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "date",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "domain_slug_example": [
          {
            "domain": "app.attio.com",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "root_domain": "attio.com",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "domain",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "email_address_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "email_domain": "app.attio.com",
            "email_address": "[email protected]",
            "attribute_type": "email-address",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "email_root_domain": "attio.com",
            "email_local_specifier": "alice",
            "original_email_address": "[email protected]"
          }
        ],
        "record_reference_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "target_object": "people",
            "attribute_type": "record-reference",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
          }
        ],
        "interaction_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "owner_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "interacted_at": "2023-06-09T20:31:13.326Z",
            "attribute_type": "interaction",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "interaction_type": "email"
          }
        ],
        "location_slug_example": [
          {
            "line_1": "1 Infinite Loop",
            "line_2": "Block 1",
            "line_3": "Hilldrop Estate",
            "line_4": "Westborough",
            "region": "CA",
            "latitude": "37.331741",
            "locality": "Cupertino",
            "postcode": "95014",
            "longitude": "-122.030333",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "country_code": "US",
            "attribute_type": "location",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "number_slug_example": [
          {
            "value": 42,
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "number",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "personal_name_slug_example": [
          {
            "full_name": "Ada Lovelace",
            "last_name": "Lovelace",
            "first_name": "Ada",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "personal-name",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "phone_number_slug_example": [
          {
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "country_code": "GB",
            "phone_number": "+447234172834",
            "attribute_type": "phone-number",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            },
            "original_phone_number": "07234172834"
          }
        ],
        "status_slug_example": [
          {
            "status": {
              "id": {
                "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
                "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
                "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
                "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
              },
              "title": "In Progress",
              "is_archived": false,
              "celebration_enabled": false,
              "target_time_in_status": "P0Y0M1DT0H0M0S"
            },
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "status",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "rating_slug_example": [
          {
            "value": 3,
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "rating",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "select_slug_example": [
          {
            "option": {
              "id": {
                "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
                "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
                "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
                "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
              },
              "title": "Medium",
              "is_archived": false
            },
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "select",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "text_slug_example": [
          {
            "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "text",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ],
        "timestamp_slug_example": [
          {
            "value": "2020-06-02T23:58:40.347847393Z",
            "active_from": "2022-11-21T13:22:49.061281000Z",
            "active_until": "2022-11-21T13:22:49.061281000Z",
            "attribute_type": "timestamp",
            "created_by_actor": {
              "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
              "type": "workspace-member"
            }
          }
        ]
      },
      "parent_object": "people",
      "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
    }
  ]
}

Create an Entry (add Record to List)

Adds a Record to a List as a new List Entry. This endpoint will throw on conflicts of unique Attributes. Multiple List Entries are allowed for the same parent Record

Scopes

list_entry:read-writerequired
list_configuration:readrequired

Path params

liststring

REQUIRED

The UUID or slug identifying the List that the created List Entry should belong to.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

POST

/v2/lists/:list/entries

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/entries \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d @- << EOF
    {
      "data": {
        "entry_values": {
          "my-attribute": [
            {
              "value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."
            }
          ]
        },
        "parent_object": "people",
        "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "actor_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "actor-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member"
        }
      ],
      "checkbox_slug_example": [
        {
          "value": true,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "checkbox",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "currency_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "currency_code": "USD",
          "attribute_type": "currency",
          "currency_value": 99,
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "date_slug_example": [
        {
          "value": "2022-11-21T13:22:49.061281000Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "date",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "domain_slug_example": [
        {
          "domain": "app.attio.com",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "root_domain": "attio.com",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "domain",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "email_address_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "email_domain": "app.attio.com",
          "email_address": "[email protected]",
          "attribute_type": "email-address",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "email_root_domain": "attio.com",
          "email_local_specifier": "alice",
          "original_email_address": "[email protected]"
        }
      ],
      "record_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "target_object": "people",
          "attribute_type": "record-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
        }
      ],
      "interaction_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "owner_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "interacted_at": "2023-06-09T20:31:13.326Z",
          "attribute_type": "interaction",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "interaction_type": "email"
        }
      ],
      "location_slug_example": [
        {
          "line_1": "1 Infinite Loop",
          "line_2": "Block 1",
          "line_3": "Hilldrop Estate",
          "line_4": "Westborough",
          "region": "CA",
          "latitude": "37.331741",
          "locality": "Cupertino",
          "postcode": "95014",
          "longitude": "-122.030333",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "US",
          "attribute_type": "location",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "number_slug_example": [
        {
          "value": 42,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "personal_name_slug_example": [
        {
          "full_name": "Ada Lovelace",
          "last_name": "Lovelace",
          "first_name": "Ada",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "personal-name",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "phone_number_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "GB",
          "phone_number": "+447234172834",
          "attribute_type": "phone-number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "original_phone_number": "07234172834"
        }
      ],
      "status_slug_example": [
        {
          "status": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "In Progress",
            "is_archived": false,
            "celebration_enabled": false,
            "target_time_in_status": "P0Y0M1DT0H0M0S"
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "status",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "rating_slug_example": [
        {
          "value": 3,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "rating",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "select_slug_example": [
        {
          "option": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "Medium",
            "is_archived": false
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "select",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "text_slug_example": [
        {
          "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "text",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "timestamp_slug_example": [
        {
          "value": "2020-06-02T23:58:40.347847393Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "timestamp",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ]
    },
    "parent_object": "people",
    "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
  }
}

Get a List Entry

Gets a single List Entry by its entry_id.

Scopes

list_entry:readrequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug identifying the List the Entry is in.

entry_idstring

REQUIRED

A UUID identifying the Entry.

Format: UUID

Response

Status code

Description

Request

GET

/v2/lists/:list/entries/:entry_id

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/entries/2e6e29ea-c4e0-4f44-842d-78a891f8c156 \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": {
    "id": {
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "actor_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "actor-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member"
        }
      ],
      "checkbox_slug_example": [
        {
          "value": true,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "checkbox",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "currency_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "currency_code": "USD",
          "attribute_type": "currency",
          "currency_value": 99,
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "date_slug_example": [
        {
          "value": "2022-11-21T13:22:49.061281000Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "date",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "domain_slug_example": [
        {
          "domain": "app.attio.com",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "root_domain": "attio.com",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "domain",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "email_address_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "email_domain": "app.attio.com",
          "email_address": "[email protected]",
          "attribute_type": "email-address",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "email_root_domain": "attio.com",
          "email_local_specifier": "alice",
          "original_email_address": "[email protected]"
        }
      ],
      "record_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "target_object": "people",
          "attribute_type": "record-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
        }
      ],
      "interaction_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "owner_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "interacted_at": "2023-06-09T20:31:13.326Z",
          "attribute_type": "interaction",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "interaction_type": "email"
        }
      ],
      "location_slug_example": [
        {
          "line_1": "1 Infinite Loop",
          "line_2": "Block 1",
          "line_3": "Hilldrop Estate",
          "line_4": "Westborough",
          "region": "CA",
          "latitude": "37.331741",
          "locality": "Cupertino",
          "postcode": "95014",
          "longitude": "-122.030333",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "US",
          "attribute_type": "location",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "number_slug_example": [
        {
          "value": 42,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "personal_name_slug_example": [
        {
          "full_name": "Ada Lovelace",
          "last_name": "Lovelace",
          "first_name": "Ada",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "personal-name",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "phone_number_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "GB",
          "phone_number": "+447234172834",
          "attribute_type": "phone-number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "original_phone_number": "07234172834"
        }
      ],
      "status_slug_example": [
        {
          "status": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "In Progress",
            "is_archived": false,
            "celebration_enabled": false,
            "target_time_in_status": "P0Y0M1DT0H0M0S"
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "status",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "rating_slug_example": [
        {
          "value": 3,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "rating",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "select_slug_example": [
        {
          "option": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "Medium",
            "is_archived": false
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "select",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "text_slug_example": [
        {
          "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "text",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "timestamp_slug_example": [
        {
          "value": "2020-06-02T23:58:40.347847393Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "timestamp",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ]
    },
    "parent_object": "people",
    "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
  }
}

Update a List Entry (append multiselect values)

Use this endpoint to update List Entries by entry_id. If the update payload includes multiselect Attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the PUT endpoint to overwrite or remove multiselect Attribute Values.

Scopes

list_entry:read-writerequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug of the List the List Entry belongs to.

entry_idstring

REQUIRED

A UUID of the List Entry to update.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

PATCH

/v2/lists/:list/entries/:entry_id

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/entries/2e6e29ea-c4e0-4f44-842d-78a891f8c156 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -X PATCH \
  -d @- << EOF
    {
      "data": {
        "entry_values": {
          "my-attribute": [
            {
              "value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."
            }
          ]
        }
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "actor_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "actor-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member"
        }
      ],
      "checkbox_slug_example": [
        {
          "value": true,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "checkbox",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "currency_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "currency_code": "USD",
          "attribute_type": "currency",
          "currency_value": 99,
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "date_slug_example": [
        {
          "value": "2022-11-21T13:22:49.061281000Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "date",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "domain_slug_example": [
        {
          "domain": "app.attio.com",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "root_domain": "attio.com",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "domain",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "email_address_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "email_domain": "app.attio.com",
          "email_address": "[email protected]",
          "attribute_type": "email-address",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "email_root_domain": "attio.com",
          "email_local_specifier": "alice",
          "original_email_address": "[email protected]"
        }
      ],
      "record_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "target_object": "people",
          "attribute_type": "record-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
        }
      ],
      "interaction_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "owner_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "interacted_at": "2023-06-09T20:31:13.326Z",
          "attribute_type": "interaction",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "interaction_type": "email"
        }
      ],
      "location_slug_example": [
        {
          "line_1": "1 Infinite Loop",
          "line_2": "Block 1",
          "line_3": "Hilldrop Estate",
          "line_4": "Westborough",
          "region": "CA",
          "latitude": "37.331741",
          "locality": "Cupertino",
          "postcode": "95014",
          "longitude": "-122.030333",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "US",
          "attribute_type": "location",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "number_slug_example": [
        {
          "value": 42,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "personal_name_slug_example": [
        {
          "full_name": "Ada Lovelace",
          "last_name": "Lovelace",
          "first_name": "Ada",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "personal-name",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "phone_number_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "GB",
          "phone_number": "+447234172834",
          "attribute_type": "phone-number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "original_phone_number": "07234172834"
        }
      ],
      "status_slug_example": [
        {
          "status": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "In Progress",
            "is_archived": false,
            "celebration_enabled": false,
            "target_time_in_status": "P0Y0M1DT0H0M0S"
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "status",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "rating_slug_example": [
        {
          "value": 3,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "rating",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "select_slug_example": [
        {
          "option": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "Medium",
            "is_archived": false
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "select",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "text_slug_example": [
        {
          "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "text",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "timestamp_slug_example": [
        {
          "value": "2020-06-02T23:58:40.347847393Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "timestamp",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ]
    },
    "parent_object": "people",
    "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
  }
}

Update a List Entry (overwrite multiselect values)

Use this endpoint to update List Entries by entry_id. If the update payload includes multiselect Attributes, the values supplied will overwrite/remove the list of values that already exist (if any). Use the PATCH endpoint to add multiselect Attribute Values without removing those value that already exist.

Scopes

list_entry:read-writerequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug of the List the List Entry belongs to.

entry_idstring

REQUIRED

A UUID of the List Entry to update.

Request Body

dataobject

REQUIRED

Response

Status code

Description

Request

PUT

/v2/lists/:list/entries/:entry_id

curl https://api.attio.com/v2/lists/33ebdbe9-e529-47c9-b894-0ba25e9c15c0/entries/2e6e29ea-c4e0-4f44-842d-78a891f8c156 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d @- << EOF
    {
      "data": {
        "entry_values": {
          "my-attribute": [
            {
              "value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."
            }
          ]
        }
      }
    }
EOF

Response

200 - Success

{
  "data": {
    "id": {
      "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",
      "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
    },
    "created_at": "2022-11-21T13:22:49.061281000Z",
    "entry_values": {
      "actor_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "actor-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "referenced_actor_type": "workspace-member"
        }
      ],
      "checkbox_slug_example": [
        {
          "value": true,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "checkbox",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "currency_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "currency_code": "USD",
          "attribute_type": "currency",
          "currency_value": 99,
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "date_slug_example": [
        {
          "value": "2022-11-21T13:22:49.061281000Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "date",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "domain_slug_example": [
        {
          "domain": "app.attio.com",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "root_domain": "attio.com",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "domain",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "email_address_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "email_domain": "app.attio.com",
          "email_address": "[email protected]",
          "attribute_type": "email-address",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "email_root_domain": "attio.com",
          "email_local_specifier": "alice",
          "original_email_address": "[email protected]"
        }
      ],
      "record_reference_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "target_object": "people",
          "attribute_type": "record-reference",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
        }
      ],
      "interaction_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "owner_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "interacted_at": "2023-06-09T20:31:13.326Z",
          "attribute_type": "interaction",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "interaction_type": "email"
        }
      ],
      "location_slug_example": [
        {
          "line_1": "1 Infinite Loop",
          "line_2": "Block 1",
          "line_3": "Hilldrop Estate",
          "line_4": "Westborough",
          "region": "CA",
          "latitude": "37.331741",
          "locality": "Cupertino",
          "postcode": "95014",
          "longitude": "-122.030333",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "US",
          "attribute_type": "location",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "number_slug_example": [
        {
          "value": 42,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "personal_name_slug_example": [
        {
          "full_name": "Ada Lovelace",
          "last_name": "Lovelace",
          "first_name": "Ada",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "personal-name",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "phone_number_slug_example": [
        {
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "country_code": "GB",
          "phone_number": "+447234172834",
          "attribute_type": "phone-number",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "original_phone_number": "07234172834"
        }
      ],
      "status_slug_example": [
        {
          "status": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "In Progress",
            "is_archived": false,
            "celebration_enabled": false,
            "target_time_in_status": "P0Y0M1DT0H0M0S"
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "status",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "rating_slug_example": [
        {
          "value": 3,
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "rating",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "select_slug_example": [
        {
          "option": {
            "id": {
              "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
              "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea",
              "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",
              "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
            },
            "title": "Medium",
            "is_archived": false
          },
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "select",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "text_slug_example": [
        {
          "value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "text",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ],
      "timestamp_slug_example": [
        {
          "value": "2020-06-02T23:58:40.347847393Z",
          "active_from": "2022-11-21T13:22:49.061281000Z",
          "active_until": "2022-11-21T13:22:49.061281000Z",
          "attribute_type": "timestamp",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          }
        }
      ]
    },
    "parent_object": "people",
    "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
  }
}

Delete a List Entry

Deletes a single List Entry by its entry_id.

Scopes

list_entry:read-writerequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug identifying the List the Entry is in.

entry_idstring

REQUIRED

A UUID identifying the Entry to delete.

Format: UUID

Response

Status code

Description

Request

DELETE

/v2/lists/:list/entries/:entry_id

curl https://api.attio.com/v2/lists/enterprise_sales/entries/2e6e29ea-c4e0-4f44-842d-78a891f8c156 \
  -H "Authorization: Bearer <token>" \
  -X DELETE

Response

200 - Success

{}

List Attribute Values for a List Entry

Gets all values for a given Attribute on a List Entry. If the Attribute is historic, this endpoint has the ability to return all historic values using the show_historic query param.

Scopes

list_entry:readrequired
list_configuration:readrequired

Path params

liststring

REQUIRED

A UUID or slug identifying the List the Entry is in.

entry_idstring

REQUIRED

A UUID identifying the Entry.

Format: UUID

attributestring

REQUIRED

A UUID or slug to identify the Attribute you want to query values on.

Query params

limitinteger

The maximum number of results to return. See the full guide to pagination here.

offsetinteger

The number of results to skip over before returning. See the full guide to pagination here.

show_historicboolean

If true, the endpoint will return all historic values for the Attribute. If false, the endpoint will only return the currently active value(s). Defaults to false. Can only be set to true for Attributes which support historic data; the endpoint will throw if set to true for non-historic Attributes.

Response

Status code

Description

Request

GET

/v2/lists/:list/entries/:entry_id/attributes/:attribute/values

curl https://api.attio.com/v2/lists/enterprise_sales/entries/2e6e29ea-c4e0-4f44-842d-78a891f8c156/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/values?limit=10&offset=5&show_historic=true \
  -H "Authorization: Bearer <token>"

Response

200 - Success

{
  "data": [
    {
      "active_from": "2022-11-21T13:22:49.061281000Z",
      "active_until": "2022-11-21T13:22:49.061281000Z",
      "attribute_type": "actor-reference",
      "created_by_actor": {
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
        "type": "workspace-member"
      },
      "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
      "referenced_actor_type": "workspace-member"
    }
  ]
}

Terms & conditions Privacy policy Security

Standard Objects

Core Data

Note

Task

Workspace Members

Webhooks

Reference

Help

Entry

List Entries

Scopes

Path params

Request Body

Response

200Success

404Not Found

Request

Response

Create an Entry (add Record to List)

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

Request

Response

Get a List Entry

Scopes

Path params

Response

200Success

404Not Found

Request

Response

Update a List Entry (append multiselect values)

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

Request

Response

Update a List Entry (overwrite multiselect values)

Scopes

Path params

Request Body

Response

200Success

400Bad Request

404Not Found

Request

Response

Delete a List Entry

Scopes

Path params

Response

200Success

404Not Found

Request

Response

List Attribute Values for a List Entry

Scopes

Path params

Query params

Response

200Success

400Bad Request

404Not Found

Request

Response