Attio

Delete an activity. Deletes a single activity by its `activity_id` or slug, along with all of its records. Archived activities can also be deleted. DELETE /v2/activities/{activity}

Delete an activity record. Deletes a single activity record by its `record_id`. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. DELETE /v2/activities/{activity}/records/{record_id}

Delete 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. A workspace-level access token may delete any comment. DELETE /v2/comments/{comment_id}

Delete a file. Delete a single file by ID. Deleting a folder will delete all of its descendants. This endpoint is in beta. DELETE /v2/files/{file_id}

Delete a list entry. Deletes a single list entry by its `entry_id`. DELETE /v2/lists/{list}/entries/{entry_id}

Delete call recording. Deletes the specified call recording. This will remove the call recording and all associated data. This endpoint is in beta. DELETE /v2/meetings/{meeting_id}/call_recordings/{call_recording_id}

Delete a note. Delete a single note by ID. DELETE /v2/notes/{note_id}

Delete a record. Deletes a single record (e.g. a company or person) by ID. DELETE /v2/objects/{object}/records/{record_id}

Delete a company record. Deletes a single company record by ID. DELETE /v2/objects/companies/records/{record_id}

Delete a deal record. Deletes a single deal record by ID. DELETE /v2/objects/deals/records/{record_id}

Delete a person Record. Deletes a single person record by ID. DELETE /v2/objects/people/records/{record_id}

Delete a user record. Deletes a single user record by ID. DELETE /v2/objects/users/records/{record_id}

Delete a workspace record. Deletes a single workspace record by ID. DELETE /v2/objects/workspaces/records/{record_id}

Delete a task. Delete a task by ID. DELETE /v2/tasks/{task_id}

Delete a webhook. Delete a webhook by ID. DELETE /v2/webhooks/{webhook_id}

List activities. Lists all system-defined and user-defined activities in your workspace. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. GET /v2/activities

Get an activity. Gets a single activity by its `activity_id` or slug. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. GET /v2/activities/{activity}

Get an activity record. Gets a single activity record by its `record_id`. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. GET /v2/activities/{activity}/records/{record_id}

List attributes. Lists all attributes defined on a specific object or list. Attributes are returned in the order that they are sorted by in the UI. GET /v2/{target}/{identifier}/attributes

Get an attribute. Gets information about a single attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read`. GET /v2/{target}/{identifier}/attributes/{attribute}

List select options. Lists all select options for a particular attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read`. GET /v2/{target}/{identifier}/attributes/{attribute}/options

List statuses. Lists all statuses for a particular status attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read`. GET /v2/{target}/{identifier}/attributes/{attribute}/statuses

Get 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. GET /v2/comments/{comment_id}

List emails. Lists email metadata from your workspace's connected mailboxes. Email content is never returned. GET /v2/emails

List files. Lists internal files, externally connected files and folders for a specific record. Use the `object` and `record_id` query parameters to specify the record. GET /v2/files

Get a file. Get a single file entry by ID. This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. GET /v2/files/{file_id}

Download a file. Downloads a file by redirecting to a signed URL. This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. GET /v2/files/{file_id}/download

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. GET /v2/lists

Get a list. Gets a single list in your workspace that your access token has access to. GET /v2/lists/{list}

Get a list entry. Gets a single list entry by its `entry_id`. GET /v2/lists/{list}/entries/{entry_id}

List attribute values for a list entry. Gets all values for a given attribute on a list entry. This endpoint has the ability to return all historic values using the `show_historic` query param. GET /v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values

List views for list. Lists saved views for a list. Results are ordered by view ID (`id.view_id` ascending). GET /v2/lists/{list}/views

List meetings. Lists all meetings in the workspace using a deterministic sort order. GET /v2/meetings

Get a meeting. Get a single meeting by ID. This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. GET /v2/meetings/{meeting_id}

List call recordings. List all call recordings for a meeting. This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. GET /v2/meetings/{meeting_id}/call_recordings

Get call recording. Get a single call recording by ID. This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. GET /v2/meetings/{meeting_id}/call_recordings/{call_recording_id}

Deprecated: Get call transcript. Deprecated: prefer using `GET /v2/meetings/:meeting_id/call_recordings/:call_recording_id` to get the transcript for a call recording. This endpoint is in beta. GET /v2/meetings/{meeting_id}/call_recordings/{call_recording_id}/transcript

List notes. List notes for all records or for a specific record. This endpoint is temporarily rate limited to 10 requests per second. GET /v2/notes

Get a note. Get a single note by ID. GET /v2/notes/{note_id}

List objects. Lists all system-defined and user-defined objects in your workspace. GET /v2/objects

Get an object. Gets a single object by its `object_id` or slug. GET /v2/objects/{object}

Get a record. Gets a single person, company or other record by its `record_id`. GET /v2/objects/{object}/records/{record_id}

List record attribute values. Gets all values for a given attribute on a record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/{object}/records/{record_id}/attributes/{attribute}/values

List record entries. List all entries, across all lists, for which this record is the parent. GET /v2/objects/{object}/records/{record_id}/entries

List views for object. Lists saved views for an object. Results are ordered by view ID (`id.view_id` ascending). GET /v2/objects/{object}/views

Get a company record. Gets a single company record by its `record_id`. GET /v2/objects/companies/records/{record_id}

List company record attribute values. Gets all values for a given attribute on a company record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/companies/records/{record_id}/attributes/{attribute}/values

List company record entries. List all entries, across all lists, for which this company record is the parent. GET /v2/objects/companies/records/{record_id}/entries

Get a deal record. Gets a single deal record by its `record_id`. GET /v2/objects/deals/records/{record_id}

List deal record attribute values. Gets all values for a given attribute on a deal record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/deals/records/{record_id}/attributes/{attribute}/values

List deal record entries. List all entries, across all lists, for which this deal record is the parent. GET /v2/objects/deals/records/{record_id}/entries

Get a person Record. Gets a single person record by its `record_id`. GET /v2/objects/people/records/{record_id}

List person record attribute values. Gets all values for a given attribute on a person record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/people/records/{record_id}/attributes/{attribute}/values

List person record entries. List all entries, across all lists, for which this person record is the parent. GET /v2/objects/people/records/{record_id}/entries

Get a user record. Gets a single user record by its `record_id`. GET /v2/objects/users/records/{record_id}

List user record attribute values. Gets all values for a given attribute on a user record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/users/records/{record_id}/attributes/{attribute}/values

List user record entries. List all entries, across all lists, for which this user record is the parent. GET /v2/objects/users/records/{record_id}/entries

Get a workspace record. Gets a single workspace record by its `record_id`. GET /v2/objects/workspaces/records/{record_id}

List workspace record attribute values. Gets all values for a given attribute on a workspace record. Historic values can be queried using the `show_historic` query param. GET /v2/objects/workspaces/records/{record_id}/attributes/{attribute}/values

List workspace record entries. List all entries, across all lists, for which this workspace record is the parent. GET /v2/objects/workspaces/records/{record_id}/entries

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

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

Get a task. Get a single task by ID. GET /v2/tasks/{task_id}

List threads. List threads of comments on a record or list entry. Each thread in the response includes at most `80` replies, starting with the oldest. GET /v2/threads

Get a thread and its comments. Get a thread and page through its comments, oldest first, starting with the comment that opened it. Comments are paginated: at most `250` are returned per request. GET /v2/threads/{thread_id}

List webhooks. Get all of the webhooks in your workspace. GET /v2/webhooks

Get a webhook. Get a single webhook. GET /v2/webhooks/{webhook_id}

List workspace members. Lists all workspace members in the workspace. GET /v2/workspace_members

Get a workspace member. Gets a single workspace member by ID. GET /v2/workspace_members/{workspace_member_id}

Update an activity. Updates a single activity by its `activity_id` or slug. The schema an activity extends is fixed after creation, so `extends` cannot be changed. PATCH /v2/activities/{activity}

Update an activity record (append multiselect values). Use this endpoint to update activity records by `record_id`. PATCH /v2/activities/{activity}/records/{record_id}

Update an attribute. Updates a single attribute on a given object or list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. PATCH /v2/{target}/{identifier}/attributes/{attribute}

Update a select option. Updates a select option on an attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. PATCH /v2/{target}/{identifier}/attributes/{attribute}/options/{option}

Update a status. Update a status on an status attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. PATCH /v2/{target}/{identifier}/attributes/{attribute}/statuses/{status}

Update a list. Updates an existing list. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters. PATCH /v2/lists/{list}

Update a list entry (append multiselect values). Use this endpoint to update list entries by `entry_id`. PATCH /v2/lists/{list}/entries/{entry_id}

Update a note. Updates an existing note's title and/or content. Only the fields you provide are changed, and any field you omit is left untouched. PATCH /v2/notes/{note_id}

Update an object. Updates a single object. The object to be updated is identified by its `object_id`. PATCH /v2/objects/{object}

Update a record (append multiselect values). Use this endpoint to update people, companies, and other records by `record_id`. PATCH /v2/objects/{object}/records/{record_id}

Update a company record. Use this endpoint to update company records by `record_id`. PATCH /v2/objects/companies/records/{record_id}

Update a deal record. Use this endpoint to update deal records by `record_id`. PATCH /v2/objects/deals/records/{record_id}

Update a person Record. Use this endpoint to update person records by `record_id`. PATCH /v2/objects/people/records/{record_id}

Update a user Record. Use this endpoint to update user records by `record_id`. PATCH /v2/objects/users/records/{record_id}

Update a workspace Record. Use this endpoint to update workspace records by `record_id`. PATCH /v2/objects/workspaces/records/{record_id}

Update 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. PATCH /v2/tasks/{task_id}

Update a webhook. Update a webhook and associated subscriptions. Each combination of target URL, event type and filter must be unique within your workspace; duplicates are rejected with a 409. PATCH /v2/webhooks/{webhook_id}

Create an activity. Creates a new custom activity in your workspace. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. POST /v2/activities

Create an activity record. Creates a new activity record, for example one specific phone call. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. POST /v2/activities/{activity}/records

List activity records. Lists activity records, with the option to filter and sort results. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. POST /v2/activities/{activity}/records/query

Create an attribute. Creates a new attribute on either an object or a list. POST /v2/{target}/{identifier}/attributes

Create a select option. Adds a select option to a select attribute on an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. POST /v2/{target}/{identifier}/attributes/{attribute}/options

Create a status. Add a new status to a status attribute on either an object or a list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. POST /v2/{target}/{identifier}/attributes/{attribute}/statuses

Create a comment. Creates a new comment related to an existing thread, record or entry. POST /v2/comments

Create a folder. Creates a native folder entry or a connected file/folder entry on an object record. This endpoint is in beta. POST /v2/files

Create a list. Creates a new list. POST /v2/lists

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. POST /v2/lists/{list}/entries

List entries. Lists entries in a given list, with the option to filter and sort results. POST /v2/lists/{list}/entries/query

Create a meeting. Creates a new meeting. [See here](/rest-api/guides/syncing-meetings) for guidance on avoiding duplicate meetings. This endpoint is in beta. POST /v2/meetings

Create call recording. Create a call recording for a meeting. This endpoint is rate limited to 1 request per second. POST /v2/meetings/{meeting_id}/call_recordings

Create a note. Creates a new note for a given record. POST /v2/notes

Create an object. Creates a new custom object in your workspace. POST /v2/objects

Create a record. Creates a new person, company or other record. This endpoint will throw on conflicts of unique attributes. POST /v2/objects/{object}/records

Merge two records. Merges two records of the same object together. Where both records have a value for the same attribute, the primary record's value takes precedence. POST /v2/objects/{object}/records/merge

List records. Lists people, company or other records, with the option to filter and sort results. POST /v2/objects/{object}/records/query

Create a company record. Creates a new company record. This endpoint will throw on conflicts of unique attributes, like `domains`. POST /v2/objects/companies/records

List company records. Lists company records, with the option to filter and sort results. POST /v2/objects/companies/records/query

Create a deal record. Creates a new deal record. This endpoint will throw on conflicts of unique attributes, if defined. POST /v2/objects/deals/records

List deal records. Lists deal records, with the option to filter and sort results. POST /v2/objects/deals/records/query

Create a person Record. Creates a new person Record. This endpoint will throw on conflicts of unique attributes, like `email_addresses`. POST /v2/objects/people/records

List person records. Lists person records, with the option to filter and sort results. POST /v2/objects/people/records/query

Search records. The search records endpoint provides a convenient way to fuzzy search for records across one or more objects. POST /v2/objects/records/search

Create a user record. Creates a new user record. This endpoint will throw on conflicts of unique attributes, like `primary_email_address`. POST /v2/objects/users/records

List user records. Lists user records, with the option to filter and sort results. POST /v2/objects/users/records/query

Create a workspace record. Creates a new workspace record. This endpoint will throw on conflicts of unique attributes, like `workspace_id`. POST /v2/objects/workspaces/records

List workspace records. Lists workspace records, with the option to filter and sort results. POST /v2/objects/workspaces/records/query

Add emails to the unsubscribe list. Adds email addresses to the workspace's sequence unsubscribe list. POST /v2/sequences/unsubscribed_emails

Query SQL. Query records and lists with SQL. Your workspace must be on the Enterprise plan in order to access this endpoint. This endpoint is in beta. POST /v2/sql

Create a task. Creates a new task. At present, tasks can only be created from plaintext without record reference formatting. POST /v2/tasks

Create a webhook. Create a webhook and associated subscriptions. Each combination of target URL, event type and filter must be unique within your workspace; duplicates are rejected with a 409. POST /v2/webhooks

Update an activity record (overwrite multiselect values). Use this endpoint to update activity records by `record_id`. PUT /v2/activities/{activity}/records/{record_id}

Upsert a list entry by parent. 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. PUT /v2/lists/{list}/entries

Update a list entry (overwrite multiselect values). Use this endpoint to update list entries by `entry_id`. PUT /v2/lists/{list}/entries/{entry_id}

Write list entry attribute values. Replaces the entire value history of a single attribute on a list entry, primarily to migrate historic data from an external source. PUT /v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values

Upsert a record. Use this endpoint to create or update people, companies and other records. A matching attribute is used to search for existing records. PUT /v2/objects/{object}/records

Update a record (overwrite multiselect values). Use this endpoint to update people, companies, and other records by `record_id`. PUT /v2/objects/{object}/records/{record_id}

Write record attribute values. Replaces the entire value history of a single attribute on a record, primarily to migrate historic data from an external source. PUT /v2/objects/{object}/records/{record_id}/attributes/{attribute}/values

Upsert a company record. Use this endpoint to create or update company records, using a unique attribute to search for existing companies (for example, the `domains` attribute). PUT /v2/objects/companies/records

Upsert a deal record. Use this endpoint to create or update deal records, using a unique attribute to search for existing deals. PUT /v2/objects/deals/records

Upsert a person record. Use this endpoint to create or update person records, using a unique attribute to search for existing People (for example the `email_addresses` attribute). PUT /v2/objects/people/records

Upsert a user record. 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). PUT /v2/objects/users/records

Upsert a workspace record. Use this endpoint to create or update workspace records, using a unique attribute to search for existing workspaces (for example the `workspace_id` attribute). PUT /v2/objects/workspaces/records