Attio integration: operations for AI agents
Attio connects to Type.com as an integration. This page lists the 97 operations documented for Claude and Codex in Type.com: 44 read, 26 write, 27 destructive.
About Attio
Attio v2 record, list, activity and workspace API reference, preserving exact scopes, token levels and destructive replacement effects; multipart file upload needs unsupported transport.
Categories: Sales & CRM
How to connect Attio to Type.com
- Connect
- Managed Pipedream OAuth when enabled; direct Bearer workspace API key or OAuth access token at fixed /v2 base
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
97 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
97 operations listed.
Objects
- Read
List objects
Lists all system-defined and user-defined objects in your workspace. Required scopes: `object_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects - Read
Get an object
Gets a single object by its `object_id` or slug. Required scopes: `object_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects/{object} - Read
List views for object
Lists saved views for an object. Results are ordered by view ID (`id.view_id` ascending). Required scopes: `object_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects/{object}/views - Write
Create an object
Creates a new custom object in your workspace. Required scopes: `object_configuration:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/objects - Write
Update an object
Updates a single object. The object to be updated is identified by its `object_id`. Required scopes: `object_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/objects/{object} - Destructive
Delete an object
Deletes a single object by its `object_id` or slug, along with all of its records. Only custom objects can be deleted; system objects, such as people and companies, cannot. This endpoint should be used with caution as it has the potential to remove a large amount of potentially valuable data. Required scopes: `object_configuration:read-write`, `record_permission:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/objects/{object}
Activities
- Read
List activities
Lists all system-defined and user-defined activities in your workspace. 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. Required scopes: `activity_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/activities - Read
Get an activity
Gets a single activity by its `activity_id` or slug. 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. Required scopes: `activity_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/activities/{activity} - Write
Create an activity
Creates a new custom activity in your workspace. Your workspace must have the custom activities billing feature enabled. Public apps may instead create activities with the integration activities billing feature. 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. Required scopes: `activity_configuration:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/activities - Write
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. 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. Required scopes: `activity_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/activities/{activity} - Destructive
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. This endpoint should be used with caution as it has the potential to remove a large amount of potentially valuable data. 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. Required scopes: `activity_configuration:read-write`, `activity_record:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/activities/{activity}
Attributes
- Read
List attributes
Lists all attributes defined on a specific object, list or activity. Attributes are returned in the order that they are sorted by in the UI. When `target` is `objects`, the required scopes are `object_configuration:read`. When `target` is `lists`, the required scopes are `list_configuration:read`. When `target` is `activities`, the required scopes are `activity_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/{target}/{identifier}/attributes - Read
Get an attribute
Gets information about a single attribute on either an object, a list or an activity. When `target` is `objects`, the required scopes are `object_configuration:read`. When `target` is `lists`, the required scopes are `list_configuration:read`. When `target` is `activities`, the required scopes are `activity_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/{target}/{identifier}/attributes/{attribute} - Read
List select options
Lists all select options for a particular attribute on either an object, a list or an activity. When `target` is `objects`, the required scopes are `object_configuration:read`. When `target` is `lists`, the required scopes are `list_configuration:read`. When `target` is `activities`, the required scopes are `activity_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/{target}/{identifier}/attributes/{attribute}/options - Read
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`. When `target` is `lists`, the required scopes are `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/{target}/{identifier}/attributes/{attribute}/statuses - Write
Create an attribute
Creates a new attribute on either an object, a list or an activity. For record-reference attributes, you can optionally create a bidirectional relationship by providing a `relationship` object. This will create two entangled attributes: one on the specified object and a reverse attribute on the related object. 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. To create an attribute on an activity, you must also have the `activity_configuration:read-write` scope. Supported token levels: `workspace`, `user`.
POST /v2/{target}/{identifier}/attributes - Write
Create a select option
Adds a select option to a select attribute on an object, a list or an activity. When `target` is `objects`, the required scopes are `object_configuration:read-write`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. When `target` is `activities`, the required scopes are `activity_configuration:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/{target}/{identifier}/attributes/{attribute}/options - Write
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`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/{target}/{identifier}/attributes/{attribute}/statuses - Destructive
Update an attribute
Updates a single attribute on a given object, list or activity. When `target` is `objects`, the required scopes are `object_configuration:read-write`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. When `target` is `activities`, the required scopes are `activity_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/{target}/{identifier}/attributes/{attribute} - Destructive
Update a select option
Updates a select option on an attribute on either an object, a list or an activity. When `target` is `objects`, the required scopes are `object_configuration:read-write`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. When `target` is `activities`, the required scopes are `activity_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/{target}/{identifier}/attributes/{attribute}/options/{option} - Destructive
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`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/{target}/{identifier}/attributes/{attribute}/statuses/{status}
Records
- Read
List records
Lists people, company or other records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/objects/{object}/records/query - Read
Get a record
Gets a single person, company or other record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects/{object}/records/{record_id} - Read
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. Historic values cannot be queried on COMINT (Communication Intelligence) or enriched attributes and the endpoint will return a 400 error if this is attempted. Historic values are sorted from oldest to newest (by `active_from`). Some attributes are subject to billing status and will return an empty array of values if theworkspace being queried does not have the required billing flag enabled. Required scopes: `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects/{object}/records/{record_id}/attributes/{attribute}/values - Read
List record entries
List all entries, across all lists, for which this record is the parent. The response includes metadata for each entry, including `entry_id`, `list_id`, and `created_at`, but does not include entry values. To retrieve the values, call [Get a list entry](/rest-api/endpoint-reference/entries/get-a-list-entry) separately for each entry. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. Supported token levels: `workspace`, `user`.
GET /v2/objects/{object}/records/{record_id}/entries - Read
Search records
The search records endpoint provides a convenient way to fuzzy search for records across one or more objects. The matching strategy employed in this endpoint follows the in-product strategy and will match names, domains, emails, phone numbers and social handles on people and companies, and labels on all other objects. Please note, results returned from this endpoint are eventually consistent. For results which are guaranteed to be up to date, please use the record query endpoint instead. 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. Required scopes: `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/objects/records/search - Write
Create 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 [Upsert record endpoint](/rest-api/endpoint-reference/records/upsert-a-record) instead. Required scopes: `record_permission:read-write`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/objects/{object}/records - Write
Update a record (append multiselect values)
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`. Supported token levels: `workspace`, `user`.
PATCH /v2/objects/{object}/records/{record_id} - Destructive
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. 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`. Supported token levels: `workspace`, `user`.
PUT /v2/objects/{object}/records - Destructive
Update a record (overwrite multiselect values)
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`. Supported token levels: `workspace`, `user`.
PUT /v2/objects/{object}/records/{record_id} - Destructive
Delete a record
Deletes a single record (e.g. a company or person) by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/objects/{object}/records/{record_id} - Destructive
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. Merging produces a **new** record, so the `new_record_id` returned will match neither of the records supplied in the request. Both of the original records are marked as merged and can no longer be read or written. Large merges are completed asynchronously. A `200` response means the merged record is readable immediately. A `202` response means the merge has been accepted but is still being applied, and reading the merged record will return a `404` with the `merge_in_progress` error code until it completes. This endpoint is not idempotent. Because both original records are marked as merged, repeating the same request returns `404`. This endpoint is rate limited to 5 requests per second. 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. Required scopes: `record_permission:read-write`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/objects/{object}/records/merge - Destructive
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. Every value the attribute currently has is destroyed, including values not present in the request, and the supplied values are written with the `active_from` and `active_until` timestamps given. Values may be supplied in any order and gaps between intervals are allowed. For attributes that accept a single value, at most one value may be active at a time, so intervals may not overlap and at most one may have a `null` `active_until`. At least one value is required. Webhooks and workflow triggers do not fire for these writes, so migrating history does not replay automations. Search indexes and caches are still updated, and formula attributes that depend on this attribute are still recalculated. Value history cannot be written for relationship attributes, formula attributes, enriched attributes, or immutable system attributes such as the entry's parent record. 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. Required scopes: `record_permission:read-write`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
PUT /v2/objects/{object}/records/{record_id}/attributes/{attribute}/values
Activity records
- Read
List activity records
Lists activity records, with the option to filter and sort results. 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. Required scopes: `activity_record:read`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/activities/{activity}/records/query - Read
Get an activity record
Gets a single activity record by its `record_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. Required scopes: `activity_record:read`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
GET /v2/activities/{activity}/records/{record_id} - Write
Create an activity record
Creates a new activity record, for example one specific phone call. 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. Required scopes: `activity_record:read-write`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/activities/{activity}/records - Write
Update an activity record (append multiselect values)
Use this endpoint to update activity 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. 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. Required scopes: `activity_record:read-write`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PATCH /v2/activities/{activity}/records/{record_id} - Destructive
Upsert an activity record
Use this endpoint to create or update an activity record. A matching attribute is used to search for existing activity 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 activity record endpoint](/rest-api/endpoint-reference/activity-records/create-an-activity-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. 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. Required scopes: `activity_record:read-write`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PUT /v2/activities/{activity}/records - Destructive
Update an activity record (overwrite multiselect values)
Use this endpoint to update activity 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. 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. Required scopes: `activity_record:read-write`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PUT /v2/activities/{activity}/records/{record_id} - Destructive
Delete an activity record
Deletes a single activity record by its `record_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. Required scopes: `activity_record:read-write`, `activity_configuration:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
DELETE /v2/activities/{activity}/records/{record_id}
SQL
- Read
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 rate limited to 2 requests per second. 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. Required scopes: `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/sql
Lists
- Read
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. Required scopes: `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/lists - Read
Get a list
Gets a single list in your workspace that your access token has access to. Required scopes: `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/lists/{list} - Read
List views for list
Lists saved views for a list. Results are ordered by view ID (`id.view_id` ascending). Required scopes: `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/lists/{list}/views - Write
Create a list
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`. Supported token levels: `workspace`, `user`.
POST /v2/lists - Destructive
Update a list
Updates an existing list. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters. Please note that lists must have either `workspace_access` set to `"full-access"` or one or more element of `workspace_member_access` with a `"full-access"` level. It is also possible to receive a `403` billing error if your workspace is not on a plan that supports either advanced workspace or workspace member level access for lists. Changing the parent object of a list is not possible through the API as it can have unintended side-effects that should be considered carefully. If you wish to carry out a parent object change you should do so through the UI. Required scopes: `list_configuration:read-write`. Supported token levels: `workspace`, `user`.
PATCH /v2/lists/{list}
Entries
- Read
List entries
Lists entries in a given list, with the option to filter and sort results. Required scopes: `list_entry:read`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/lists/{list}/entries/query - Read
Get a list entry
Gets a single list entry by its `entry_id`. Required scopes: `list_entry:read`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/lists/{list}/entries/{entry_id} - Read
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. Historic values are sorted from oldest to newest (by `active_from`). Required scopes: `list_entry:read`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
GET /v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values - Write
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 Required scopes: `list_entry:read-write`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
POST /v2/lists/{list}/entries - Write
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. Required scopes: `list_entry:read-write`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
PATCH /v2/lists/{list}/entries/{entry_id} - Destructive
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. 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`. Supported token levels: `workspace`, `user`.
PUT /v2/lists/{list}/entries - Destructive
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. Required scopes: `list_entry:read-write`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
PUT /v2/lists/{list}/entries/{entry_id} - Destructive
Delete a list entry
Deletes a single list entry by its `entry_id`. Required scopes: `list_entry:read-write`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
DELETE /v2/lists/{list}/entries/{entry_id} - Destructive
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. Every value the attribute currently has is destroyed, including values not present in the request, and the supplied values are written with the `active_from` and `active_until` timestamps given. Values may be supplied in any order and gaps between intervals are allowed. For attributes that accept a single value, at most one value may be active at a time, so intervals may not overlap and at most one may have a `null` `active_until`. At least one value is required. Webhooks and workflow triggers do not fire for these writes, so migrating history does not replay automations. Search indexes and caches are still updated, and formula attributes that depend on this attribute are still recalculated. Value history cannot be written for relationship attributes, formula attributes, enriched attributes, or immutable system attributes such as the entry's parent record. 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. Required scopes: `list_entry:read-write`, `list_configuration:read`. Supported token levels: `workspace`, `user`.
PUT /v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values
Workspace members
- Read
List workspace members
Lists all workspace members in the workspace. Required scopes: `user_management:read`. Supported token levels: `workspace`, `user`.
GET /v2/workspace_members - Read
Get a workspace member
Gets a single workspace member by ID. Required scopes: `user_management:read`. Supported token levels: `workspace`, `user`.
GET /v2/workspace_members/{workspace_member_id}
Notes
- Read
List notes
List notes for all records or for a specific record. This endpoint is temporarily rate limited to 10 requests per second. Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
GET /v2/notes - Read
Get a note
Get a single note by ID. Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
GET /v2/notes/{note_id} - Write
Create a note
Creates a new note for a given record. Required scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/notes - Write
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. Providing `content` replaces the note's entire content. A note's parent record cannot be changed. Required scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PATCH /v2/notes/{note_id} - Destructive
Delete a note
Delete a single note by ID. Required scopes: `note:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/notes/{note_id}
Tasks
- Read
List tasks
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`. Supported token levels: `workspace`, `user`.
GET /v2/tasks - Read
Get a task
Get a single task by ID. Required scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`. Supported token levels: `workspace`, `user`.
GET /v2/tasks/{task_id} - Write
Create a task
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`. Supported token levels: `workspace`, `user`.
POST /v2/tasks - Write
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. Required scopes: `task:read-write`, `object_configuration:read`, `record_permission:read`, `user_management:read`. Supported token levels: `workspace`, `user`.
PATCH /v2/tasks/{task_id} - Destructive
Delete a task
Delete a task by ID. Required scopes: `task:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/tasks/{task_id}
Threads
- Read
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. When a thread holds more, its `has_more_comments` is `true`; use [Get a thread and its comments](/rest-api/endpoint-reference/threads/get-a-thread-and-its-comments) to page through every comment in that 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`. Supported token levels: `workspace`, `user`.
GET /v2/threads - Read
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. Keep paginating for as long as a `next_cursor` is returned. Supply `created_after` to return only the comments created after a timestamp, which is useful when polling a thread for new replies. The comment that opened the thread is returned only when it also satisfies the filter. 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`. Supported token levels: `workspace`, `user`.
GET /v2/threads/{thread_id}
Comments
- Read
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. To view comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes. Required scopes: `comment:read`. Supported token levels: `workspace`, `user`.
GET /v2/comments/{comment_id} - Write
Create a comment
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`. Supported token levels: `workspace`, `user`.
POST /v2/comments - Destructive
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. A user-level access token may only delete comments authored by the member it acts for. Required scopes: `comment:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/comments/{comment_id}
Emails
- Read
List emails
Lists email metadata from your workspace's connected mailboxes. Email content is never returned. At least one of `linked_object` with `linked_record_ids`, `participants`, or `domain` must be supplied; there is no way to list every email. When several are supplied they are combined with OR: emails matching any of the filters are returned. > **Requesting access:** this endpoint is enabled per workspace and per app while it is in alpha. Contact [support@attio.com](mailto:support@attio.com) to request access. **Things to know** - Filters that identify your own workspace are ignored. This covers a member's or invited member's address, one of your mailboxes, and any of their domains. If every filter you supply is ignored, an empty page is returned. - A filter that names a protected recipient in your workspace is rejected rather than ignored. This covers an address or a domain you supply directly. A record whose address or domain is a protected recipient is ignored instead, in the same way as the filters above. - Emails from a mailbox shared with your workspace as metadata only are returned without a subject line. An email is left out entirely when it has no participant you may see — that is, when every participant outside your workspace is a protected recipient. - An email that reached more than one of your mailboxes is returned once, and `id.mailbox_id` identifies whichever copy was readable. - `linked_records` is derived when you make the request rather than stored, so it reflects your records as they are now. - Emails are returned newest first, ordered by when they were sent. Each request scans a bounded number of emails, so a page can hold fewer emails than `limit`, or none at all, while more are still available. Keep paginating for as long as a `next_cursor` is returned, rather than stopping on a short page. This endpoint is in alpha and may be subject to breaking changes as we gather feedback. Required scopes: `email:read`, `record_permission:read`, `object_configuration:read`. Supported token levels: `workspace`.
GET /v2/emails
Sequences
- Destructive
Add emails to the unsubscribe list
Adds email addresses to the workspace's sequence unsubscribe list. Email addresses on the unsubscribe list cannot be enrolled in any sequence, and any of their active sequence runs are exited. Email addresses that are already on the unsubscribe list are ignored, so this endpoint is safe to retry. 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. Required scopes: `sequence_unsubscribe:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/sequences/unsubscribed_emails
Meetings
- Read
List meetings
Lists all meetings in the workspace using a deterministic sort order. When both the `participants` and `linked_record_id` filters are supplied, they are combined with OR: meetings that match either filter are returned. 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. Required scopes: `meeting:read`, `record_permission:read`. Supported token levels: `workspace`.
GET /v2/meetings - Read
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. Required scopes: `meeting:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
GET /v2/meetings/{meeting_id} - Write
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. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. Required scopes: `meeting:read-write`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/meetings - Write
Update a meeting (append linked records)
Links records to a meeting. The records supplied are added to the meeting's existing linked records, and records which are already linked are ignored. Use the `PUT` endpoint to replace or remove linked records. No other meeting fields can be updated. Attio automatically links the meeting participants' companies to the meeting; this behavior is asynchronous. 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. Required scopes: `meeting:read-write`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PATCH /v2/meetings/{meeting_id} - Destructive
Update a meeting (overwrite linked records)
Replaces a meeting's linked records with the records supplied. Any record which is currently linked and is not in the request is unlinked, including records which Attio linked automatically from the meeting's participants. Passing an empty array unlinks every record. Use the `PATCH` endpoint to add linked records without removing the records which already exist. No other meeting fields can be updated. Attio automatically links the meeting participants' companies to the meeting; this behavior is asynchronous, so a company which is linked after this request completes is not removed by it. 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. Required scopes: `meeting:read-write`, `record_permission:read`. Supported token levels: `workspace`, `user`.
PUT /v2/meetings/{meeting_id} - Destructive
Delete a meeting
Deletes a single meeting by ID. Meetings created by calendar sync cannot be deleted through the API. Delete the underlying calendar event, or disconnect the calendar, instead. 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. Required scopes: `meeting:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/meetings/{meeting_id}
Call recordings
- Read
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. Required scopes: `meeting:read`, `call_recording:read`. Supported token levels: `workspace`, `user`.
GET /v2/meetings/{meeting_id}/call_recordings - Read
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. Required scopes: `meeting:read`, `call_recording:read`. Supported token levels: `workspace`, `user`.
GET /v2/meetings/{meeting_id}/call_recordings/{call_recording_id} - Write
Create call recording
Create a call recording for a meeting. This endpoint is rate limited to 1 request per second. A `transcript` is required. `video_url` is optional, and a transcript-only call recording (with no video) is fully supported. 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. Required scopes: `meeting:read`, `call_recording:read-write`. Supported token levels: `workspace`, `user`.
POST /v2/meetings/{meeting_id}/call_recordings - Destructive
Delete call recording
Deletes the specified call recording. This will remove the call recording and all associated data. 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. Required scopes: `meeting:read`, `call_recording:read-write`. Supported token levels: `workspace`, `user`.
DELETE /v2/meetings/{meeting_id}/call_recordings/{call_recording_id}
Transcripts
- Read
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. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users. Required scopes: `meeting:read`, `call_recording:read`. Supported token levels: `workspace`.
GET /v2/meetings/{meeting_id}/call_recordings/{call_recording_id}/transcript
Files
- Read
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. Optional query parameters may be provided to filter results by storage provider or parent folder. 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. Required scopes: `object_configuration:read`, `record_permission:read`, `file:read`. Supported token levels: `workspace`, `user`.
GET /v2/files - Read
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. Required scopes: `file:read`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
GET /v2/files/{file_id} - Read
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. Required scopes: `object_configuration:read`, `record_permission:read`, `file:read`. Supported token levels: `workspace`, `user`.
GET /v2/files/{file_id}/download - Write
Create a folder
Creates a native folder entry or a connected file/folder entry on an object record. 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. Required scopes: `file:read-write`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/files - Write
Upload a file
Uploads a file to native Attio storage for a record. Send multipart/form-data with a single binary field named `file` together with the body fields `object`, `record_id`, and optional `parent_folder_id`. Maximum file size is 50 MB. This endpoint is rate limited to 1 request per second. 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. Required scopes: `file:read-write`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
POST /v2/files/upload - Destructive
Delete a file
Delete a single file by ID. Deleting a folder will delete all of its descendants. 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. Required scopes: `file:read-write`, `object_configuration:read`, `record_permission:read`. Supported token levels: `workspace`, `user`.
DELETE /v2/files/{file_id}
Webhooks
- Read
List webhooks
Get all of the webhooks in your workspace. Required scopes: `webhook:read`. Supported token levels: `workspace`.
GET /v2/webhooks - Read
Get a webhook
Get a single webhook. Required scopes: `webhook:read`. Supported token levels: `workspace`.
GET /v2/webhooks/{webhook_id} - Write
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. Required scopes: `webhook:read-write`. Supported token levels: `workspace`.
POST /v2/webhooks - Write
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. Changing the target URL re-checks the webhook's existing subscriptions against the new URL. Required scopes: `webhook:read-write`. Supported token levels: `workspace`.
PATCH /v2/webhooks/{webhook_id} - Destructive
Delete a webhook
Delete a webhook by ID. Required scopes: `webhook:read-write`. Supported token levels: `workspace`.
DELETE /v2/webhooks/{webhook_id}
Meta
- Read
Identify
Identify the current access token, the workspace it is linked to, and any permissions it has. Every kind of Attio access token can be introspected: - **Workspace access tokens**, created from a workspace's settings. These have no OAuth client, so `client_id` and `aud` contain the workspace access token's own ID. - **OAuth access tokens**, granted to an app through the OAuth 2.0 authorization code flow. `client_id` and `aud` contain the app ID. - **App access tokens**, issued to an app installation and exposed to that app's server functions as `ATTIO_API_TOKEN`. `client_id` and `aud` contain the app ID. Per [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662), `active` is the only member guaranteed to be present. `exp` is always `null`, because Attio access tokens do not currently expire. All other members are optional, and are omitted rather than returned as `null` when they are not present. Unknown, revoked, and deleted tokens are not treated as an error. They return `200` with `{"active": false}` and no other members.
GET /v2/self
No operations match.
Get started
- Open Space settings → Connections and search for Attio.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.