th {
    text-align: left;
}

:not(pre) > code {
    padding: 0.125rem;
}

.mermaid-inline button {
    width: 100%;
    display: flex;
    justify-content: center;
    align-items: center;
}

.mermaid-inline button > a {
    width: 100%;
}

img[alt~="logo"] {
    width: 90px;
}

.rounded-xl {
    border-radius: 10px;
}

.rounded-2xl {
    border-radius: 10px;
}

#navbar div > a[href="/sdk/introduction"] {
    position: relative;
}

#navbar div > a[href="/sdk/introduction"]::after {
    content: "Alpha";
    display: inline-block;
    font-size: 0.7rem;
    font-weight: 600;
    color: #0066ff;
    background-color: rgba(0, 102, 255, 0.1);
    padding: 0.1rem 0.4rem;
    border-radius: 4px;
    margin-left: 0.5rem;
}

#navigation-items > ul > li > a[href="/sdk/introduction"] {
    position: relative;
}

#navigation-items > ul > li > a[href="/sdk/introduction"]::after {
    content: "Alpha";
    display: inline-block;
    font-size: 0.7rem;
    font-weight: 600;
    color: #0066ff;
    background-color: rgba(0, 102, 255, 0.1);
    padding: 0.1rem 0.4rem;
    border-radius: 4px;
    margin-left: 0.5rem;
}


Get a single task by ID.

Required scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`.

Get a task

The plaintext representation of the task content. Inline linked records will appear as "@record name" and are returned in the `linked_records` property.

The type of actor. [Read more information on actor types here](/docs/actors).

The deadline date of the task. Returned as an ISO 8601 timestamp.

The ID of the workspace the task belongs to.

Records linked to the task. Creating record links within task content text is not possible via the API at present.

oauth2

Attio Docs

Lists all system-defined and user-defined objects in your workspace.

Required scopes: `object_configuration:read`.

List objects

Creates a new custom object in your workspace.

Required scopes: `object_configuration:read-write`.

Create an object

Gets a single object by its `object_id` or slug.

Required scopes: `object_configuration:read`.

Get an object

Updates a single object. The object to be updated is identified by its `object_id`.

Required scopes: `object_configuration:read-write`.

Update an object

Lists all attributes defined on a specific object or list. Attributes are returned in the order that they are sorted by in the UI.

Required scopes: `object_configuration:read`.

List attributes

Creates a new attribute on either an object or a list.

To create an attribute on an object, you must also have the `object_configuration:read-write` scope.

To create an attribute on a list, you must also have the `list_configuration:read-write` scope.

Create an attribute

Gets information about a single attribute on either an object or a list.

Required scopes: `object_configuration:read`.

Get an attribute

Updates a single attribute on a given object or list.

Required scopes: `object_configuration:read-write`.

Update an attribute

Lists all select options for a particular attribute on either an object or a list.

Required scopes: `object_configuration:read`.

List select options

Adds a select option to a select attribute on an object or a list.

Required scopes: `object_configuration:read-write`.

Create a select option

Updates a select option on an attribute on either an object or a list.

Required scopes: `object_configuration:read-write`.

Update a select option

Lists all statuses for a particular status attribute on either an object or a list.

Required scopes: `object_configuration:read`.

List statuses

Add a new status to a status attribute on either an object or a list.

Required scopes: `object_configuration:read-write`.

Create a status

Update a status on an status attribute on either an object or a list.

Required scopes: `object_configuration:read-write`.

Update a status

Lists people, company or other records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

List records

Use this endpoint to create or update people, companies and other records. A matching attribute is used to search for existing records. If a record is found with the same value for the matching attribute, that record will be updated. If no record with the same value for the matching attribute is found, a new record will be created instead. If you would like to avoid matching, please use the [Create record endpoint](/rest-api/endpoint-reference/records/create-a-record).

If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a record

Creates a new person, company or other record. This endpoint will throw on conflicts of unique attributes. If you would prefer to update records on conflicts, please use the [Assert record endpoint](/rest-api/endpoint-reference/records/assert-a-record) instead.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a record

Gets a single person, company or other record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a record

Use this endpoint to update people, companies, and other records by `record_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 append multiselect values without removing those that already exist.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a record (overwrite multiselect values)

Deletes a single record (e.g. a company or person) by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a record

Use this endpoint to update people, companies, and other records by `record_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.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a record (append multiselect values)

Gets all values for a given attribute on a record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List record attribute values

List all entries, across all lists, for which this record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List record entries

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`.

List all lists

Creates a new list.

Once you have your list, add attributes to it using the [Create attribute](/rest-api/endpoint-reference/attributes/create-an-attribute) API, and add records to it using the [Add records to list](/rest-api/endpoint-reference/entries/create-an-entry-add-record-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`.

Create a list

Gets a single list in your workspace that your access token has access to.

Required scopes: `list_configuration:read`.

Get 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.

Required scopes: `list_configuration:read-write`.

Update a list

Lists entries in a given list, with the option to filter and sort results.

Required scopes: `list_entry:read`, `list_configuration:read`.

List entries

Use this endpoint to create or update a list entry for a given parent record. If an entry with the specified parent record is found, that entry will be updated. If no such entry is found, a new entry will be created instead. If there are multiple entries with the same parent record, this endpoint with return the "MULTIPLE_MATCH_RESULTS" error. When writing to multi-select attributes, all values will be either created or deleted as necessary to match the list of values supplied in the request body.

Required scopes: `list_entry:read-write`, `list_configuration:read`.

Assert a list entry by parent

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

Required scopes: `list_entry:read-write`, `list_configuration:read`.

Create an entry (add record to list)

Gets a single list entry by its `entry_id`.

Required scopes: `list_entry:read`, `list_configuration:read`.

Get a list entry

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.

Required scopes: `list_entry:read-write`, `list_configuration:read`.

Update a list entry (overwrite multiselect values)

Deletes a single list entry by its `entry_id`.

Required scopes: `list_entry:read-write`, `list_configuration:read`.

Delete a list entry

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.

Required scopes: `list_entry:read-write`, `list_configuration:read`.

Update a list entry (append multiselect values)

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.

Required scopes: `list_entry:read`, `list_configuration:read`.

List attribute values for a list entry

Lists all workspace members in the workspace.

Required scopes: `user_management:read`.

List workspace members

Gets a single workspace member by ID.

Required scopes: `user_management:read`.

Get a workspace member

List notes for all records or for a specific record.

Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`.

List notes

Creates a new note for a given record.

Required scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`.

Create a note

Get a single note by ID.

Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`.

Get a note

Delete a single note by ID.

Required scopes: `note:read-write`.

Delete a note

List all tasks. Results are sorted by creation date, from oldest to newest.

Required scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`.

List tasks

Creates a new task.

At present, tasks can only be created from plaintext without record reference formatting.

Required scopes: `task:read-write`, `object_configuration:read`, `record_permission:read`, `user_management:read`.

Create a task

Delete a task by ID.

Required scopes: `task:read-write`.

Delete a task

Updates an existing task by `task_id`. At present, only the `deadline_at`, `is_completed`, `linked_records`, and `assignees` fields can be updated.

Required scopes: `task:read-write`, `object_configuration:read`, `record_permission:read`, `user_management:read`.

Update a task

List threads of comments on a record or list entry.

To view threads on records, you will need the `object_configuration:read` and `record_permission:read` scopes.

To view threads on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.

Required scopes: `comment:read`.

List threads

Get all comments in a thread.

To view threads on records, you will need the `object_configuration:read` and `record_permission:read` scopes.

To view threads on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.

Required scopes: `comment:read`.

Get a thread

Creates a new comment related to an existing thread, record or entry.

To create comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.

To create comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.

Required scopes: `comment:read-write`.

Create a comment

Get a single comment by ID.

To view comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.

To view comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.

Required scopes: `comment:read`.

Get a comment

Deletes a comment by ID. If deleting a comment at the head of a thread, all messages in the thread are also deleted.

Required scopes: `comment:read-write`.

Delete a comment

Get all of the webhooks in your workspace.

Required scopes: `webhook:read`.

List webhooks

Create a webhook and associated subscriptions.

Required scopes: `webhook:read-write`.

Create a webhook

Get a single webhook.

Required scopes: `webhook:read`.

Get a webhook

Delete a webhook by ID.

Required scopes: `webhook:read-write`.

Delete a webhook

Update a webhook and associated subscriptions.

Required scopes: `webhook:read-write`.

Update a webhook

Identify the current access token, the workspace it is linked to, and any permissions it has.

Identify

Lists person records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

List person records 

Use this endpoint to create or update person records, using a unique attribute to search for existing People (for example the `email_addresses` attribute). If a person is found with the same value for the matching attribute, that person will be updated. If no person with the same value for the matching attribute is found, a new person will be created instead. If you would like to avoid matching, please use the Create person endpoint.


If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a person Record

Creates a new person Record. This endpoint will throw on conflicts of unique attributes, like `email_addresses`. If you would prefer to update person records on conflicts, please use the Assert person record endpoint instead. Please note, the `avatar_url` attribute cannot currently be set via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a person Record

Gets a single person record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a person Record

Deletes a single person record by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a person Record

Use this endpoint to update person records by `record_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 [Assert person endpoint](/reference/put_v2-objects-people-records) to overwrite or remove multiselect attribute values. Please note, the `avatar_url` attribute cannot currently be updated via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a person Record

Gets all values for a given attribute on a person Record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List person record attribute values

List all entries, across all lists, for which this person record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List person record entries

Lists company records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

List company records

Use this endpoint to create or update company records, using a unique attribute to search for existing companies (for example, the `domains` attribute). If a company is found with the same value for the matching attribute, that company will be updated. If no company with the same value for the matching attribute is found, a new company will be created instead. If you would like to avoid matching, please use the Create company endpoint.


If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a company record

Creates a new company record. This endpoint will throw on conflicts of unique attributes, like `domains`. If you would prefer to update company records on conflicts, please use the Assert company record endpoint instead. Please note, the `logo_url` attribute cannot currently be set via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a company record

Gets a single company record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a company record

Deletes a single company record by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a company record

Use this endpoint to update company records by `record_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 [Assert company endpoint](/rest-api/endpoint-reference/standard-objects/companies/assert-a-company-record) to overwrite or remove multiselect attribute values. Please note, the `logo_url` attribute cannot currently be updated via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a company record

Gets all values for a given attribute on a company record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List company record attribute values

List all entries, across all lists, for which this company record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List company record entries

Lists user records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

List user records

Use this endpoint to create or update user records, using a unique attribute to search for existing users (for example the `primary_email_address` attribute). If a user is found with the same value for the matching attribute, that user will be updated, otherwise a new user will be created instead. If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a user record

Creates a new user record. This endpoint will throw on conflicts of unique attributes, like `primary_email_address`. If you would prefer to update user records on conflicts, please use the Assert user record endpoint instead. Please note, the `avatar_url` attribute cannot currently be set via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a user record

Gets a single user record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a user record

Deletes a single user record by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a user record

Use this endpoint to update user records by `record_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 [Assert user endpoint](/reference/put_v2-objects-users-records) to overwrite or remove multiselect attribute values. Please note, the `avatar_url` attribute cannot currently be updated via the API.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a user Record

Gets all values for a given attribute on a user record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List user record attribute values

List all entries, across all lists, for which this user record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List user record entries

Use this endpoint to create or update deal records, using a unique attribute to search for existing deals. By default, deals do not have a unique attribute, so you should add your own attribute with a unique constraint to use this API. If a deal is found with the same value for the matching attribute, that deal will be updated, otherwise a new deal will be created instead. If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a deal record

Creates a new deal record. This endpoint will throw on conflicts of unique attributes, if defined. If you would prefer to update deal records on conflicts, please use the Assert deal record endpoint instead.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a deal record

Gets a single deal record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a deal record

Deletes a single deal record by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a deal record

Use this endpoint to update deal records by `record_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 [Assert deal endpoint](/rest-api/endpoint-reference/standard-objects/deals/assert-a-deal-record) to overwrite or remove multiselect attribute values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a deal record

Gets all values for a given attribute on a deal record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List deal record attribute values

List all entries, across all lists, for which this deal record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List deal record entries

Lists deal records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

List deal records

Use this endpoint to create or update workspace records, using a unique attribute to search for existing workspaces (for example the `workspace_id` attribute). If a workspace is found with the same value for the matching attribute, that workspace will be updated, otherwise a new workspace will be created instead. If the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Assert a workspace record

Creates a new workspace record. This endpoint will throw on conflicts of unique attributes, like `workspace_id`. If you would prefer to update workspace records on conflicts, please use the Assert workspace record endpoint instead.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Create a workspace record

Gets a single workspace record by its `record_id`.

Required scopes: `record_permission:read`, `object_configuration:read`.

Get a workspace record

Deletes a single workspace record by ID.

Required scopes: `object_configuration:read`, `record_permission:read-write`.

Delete a workspace record

Use this endpoint to update workspace records by `record_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 [Assert workspace endpoint](/rest-api/endpoint-reference/standard-objects/workspaces/assert-a-workspace-record) to overwrite or remove multiselect attribute values.

Required scopes: `record_permission:read-write`, `object_configuration:read`.

Update a workspace Record

Gets all values for a given attribute on a workspace record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.

Required scopes: `record_permission:read`, `object_configuration:read`.

List workspace record attribute values

List all entries, across all lists, for which this workspace record is the parent.

Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.

List workspace record entries

Lists workspace records, with the option to filter and sort results.

Required scopes: `record_permission:read`, `object_configuration:read`.

Introduction

How-to guides

Tutorials

Endpoint reference

Get a task

Authorizations

Path Parameters

Response