Attio
Manage records, notes, tasks, lists, comments, and more in Attio CRM
Connect to Attio to manage CRM records (people, companies, custom objects), notes, tasks, lists, list entries, comments, workspace members, and webhooks.
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
filter | string | No | No description |
sorts | string | No | JSON array of sort objects, e.g. [{"direction":"asc","attribute":"name"}] |
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
records | array | Array of Attio records |
↳ id | object | The record identifier |
↳ workspace_id | string | The workspace ID |
↳ object_id | string | The object ID |
↳ record_id | string | The record ID |
↳ created_at | string | When the record was created |
↳ web_url | string | URL to view the record in Attio |
↳ values | json | The record attribute values |
count | number | Number of records returned |
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
recordId | string | Yes | No description |
| Parameter | Type | Description |
|---|
record | object | An Attio record |
↳ id | object | The record identifier |
↳ workspace_id | string | The workspace ID |
↳ object_id | string | The object ID |
↳ record_id | string | The record ID |
↳ created_at | string | When the record was created |
↳ web_url | string | URL to view the record in Attio |
↳ values | json | The record attribute values |
recordId | string | The record ID |
webUrl | string | URL to view the record in Attio |
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
values | string | Yes | No description |
| Parameter | Type | Description |
|---|
record | object | An Attio record |
↳ id | object | The record identifier |
↳ workspace_id | string | The workspace ID |
↳ object_id | string | The object ID |
↳ record_id | string | The record ID |
↳ created_at | string | When the record was created |
↳ web_url | string | URL to view the record in Attio |
↳ values | json | The record attribute values |
recordId | string | The ID of the created record |
webUrl | string | URL to view the record in Attio |
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
recordId | string | Yes | No description |
values | string | Yes | No description |
| Parameter | Type | Description |
|---|
record | object | An Attio record |
↳ id | object | The record identifier |
↳ workspace_id | string | The workspace ID |
↳ object_id | string | The object ID |
↳ record_id | string | The record ID |
↳ created_at | string | When the record was created |
↳ web_url | string | URL to view the record in Attio |
↳ values | json | The record attribute values |
recordId | string | The ID of the updated record |
webUrl | string | URL to view the record in Attio |
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
recordId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the record was deleted |
| Parameter | Type | Required | Description |
|---|
query | string | Yes | No description |
objects | string | Yes | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
results | array | Search results |
↳ recordId | string | The record ID |
↳ objectId | string | The object type ID |
↳ objectSlug | string | The object type slug |
↳ recordText | string | Display text for the record |
↳ recordImage | string | Image URL for the record |
count | number | Number of results returned |
Upsert a record in Attio — creates it if no match is found, updates it if a match exists
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | No description |
matchingAttribute | string | Yes | The attribute slug to match on for upsert (e.g. email_addresses for people, domains for companies) |
values | string | Yes | JSON object of attribute values (e.g. {"email_addresses":[{"email_address":"test@example.com"}]}) |
| Parameter | Type | Description |
|---|
record | object | The upserted record |
↳ id | object | The record identifier |
↳ workspace_id | string | The workspace ID |
↳ object_id | string | The object ID |
↳ record_id | string | The record ID |
↳ created_at | string | When the record was created |
↳ web_url | string | URL to view the record in Attio |
↳ values | json | The record attribute values |
recordId | string | The record ID |
webUrl | string | URL to view the record in Attio |
| Parameter | Type | Required | Description |
|---|
parentObject | string | No | No description |
parentRecordId | string | No | No description |
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
notes | array | Array of notes |
↳ noteId | string | The note ID |
↳ parentObject | string | The parent object slug |
↳ parentRecordId | string | The parent record ID |
↳ title | string | The note title |
↳ contentPlaintext | string | The note content as plaintext |
↳ contentMarkdown | string | The note content as markdown |
↳ meetingId | string | The linked meeting ID |
↳ tags | array | Tags on the note |
↳ type | string | The tag type (e.g. workspace-member) |
↳ workspaceMemberId | string | The workspace member ID of the tagger |
↳ createdByActor | object | The actor who created the note |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
↳ createdAt | string | When the note was created |
count | number | Number of notes returned |
| Parameter | Type | Required | Description |
|---|
noteId | string | Yes | No description |
| Parameter | Type | Description |
|---|
noteId | string | The note ID |
parentObject | string | The parent object slug |
parentRecordId | string | The parent record ID |
title | string | The note title |
contentPlaintext | string | The note content as plaintext |
contentMarkdown | string | The note content as markdown |
meetingId | string | The linked meeting ID |
tags | array | Tags on the note |
↳ type | string | The tag type (e.g. workspace-member) |
↳ workspaceMemberId | string | The workspace member ID of the tagger |
createdByActor | object | The actor who created the note |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the note was created |
| Parameter | Type | Required | Description |
|---|
parentObject | string | Yes | No description |
parentRecordId | string | Yes | No description |
title | string | Yes | No description |
content | string | Yes | No description |
format | string | No | No description |
createdAt | string | No | No description |
meetingId | string | No | No description |
| Parameter | Type | Description |
|---|
noteId | string | The note ID |
parentObject | string | The parent object slug |
parentRecordId | string | The parent record ID |
title | string | The note title |
contentPlaintext | string | The note content as plaintext |
contentMarkdown | string | The note content as markdown |
meetingId | string | The linked meeting ID |
tags | array | Tags on the note |
↳ type | string | The tag type (e.g. workspace-member) |
↳ workspaceMemberId | string | The workspace member ID of the tagger |
createdByActor | object | The actor who created the note |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the note was created |
| Parameter | Type | Required | Description |
|---|
noteId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the note was deleted |
| Parameter | Type | Required | Description |
|---|
linkedObject | string | No | No description |
linkedRecordId | string | No | No description |
assignee | string | No | No description |
isCompleted | boolean | No | No description |
sort | string | No | No description |
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
tasks | array | Array of tasks |
↳ taskId | string | The task ID |
↳ content | string | The task content |
↳ deadlineAt | string | The task deadline |
↳ isCompleted | boolean | Whether the task is completed |
↳ linkedRecords | array | Records linked to this task |
↳ targetObjectId | string | The linked object ID |
↳ targetRecordId | string | The linked record ID |
↳ assignees | array | Task assignees |
↳ type | string | The assignee actor type (e.g. workspace-member) |
↳ id | string | The assignee actor ID |
↳ createdByActor | object | The actor who created this task |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
↳ createdAt | string | When the task was created |
count | number | Number of tasks returned |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | No description |
| Parameter | Type | Description |
|---|
taskId | string | The task ID |
content | string | The task content |
deadlineAt | string | The task deadline |
isCompleted | boolean | Whether the task is completed |
linkedRecords | array | Records linked to this task |
↳ targetObjectId | string | The linked object ID |
↳ targetRecordId | string | The linked record ID |
assignees | array | Task assignees |
↳ type | string | The assignee actor type (e.g. workspace-member) |
↳ id | string | The assignee actor ID |
createdByActor | object | The actor who created this task |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the task was created |
| Parameter | Type | Required | Description |
|---|
content | string | Yes | No description |
deadlineAt | string | No | No description |
isCompleted | boolean | No | No description |
linkedRecords | string | No | JSON array of linked records (e.g. [{"target_object":"people","target_record_id":"..."}]) |
assignees | string | No | JSON array of assignees (e.g. [{"referenced_actor_type":"workspace-member","referenced_actor_id":"..."}]) |
| Parameter | Type | Description |
|---|
taskId | string | The task ID |
content | string | The task content |
deadlineAt | string | The task deadline |
isCompleted | boolean | Whether the task is completed |
linkedRecords | array | Records linked to this task |
↳ targetObjectId | string | The linked object ID |
↳ targetRecordId | string | The linked record ID |
assignees | array | Task assignees |
↳ type | string | The assignee actor type (e.g. workspace-member) |
↳ id | string | The assignee actor ID |
createdByActor | object | The actor who created this task |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the task was created |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | No description |
deadlineAt | string | No | No description |
isCompleted | boolean | No | No description |
linkedRecords | string | No | No description |
assignees | string | No | No description |
| Parameter | Type | Description |
|---|
taskId | string | The task ID |
content | string | The task content |
deadlineAt | string | The task deadline |
isCompleted | boolean | Whether the task is completed |
linkedRecords | array | Records linked to this task |
↳ targetObjectId | string | The linked object ID |
↳ targetRecordId | string | The linked record ID |
assignees | array | Task assignees |
↳ type | string | The assignee actor type (e.g. workspace-member) |
↳ id | string | The assignee actor ID |
createdByActor | object | The actor who created this task |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the task was created |
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the task was deleted |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
objects | array | Array of objects |
↳ objectId | string | The object ID |
↳ apiSlug | string | The API slug (e.g. people, companies) |
↳ singularNoun | string | Singular display name |
↳ pluralNoun | string | Plural display name |
↳ createdAt | string | When the object was created |
count | number | Number of objects returned |
| Parameter | Type | Required | Description |
|---|
object | string | Yes | No description |
| Parameter | Type | Description |
|---|
objectId | string | The object ID |
apiSlug | string | The API slug (e.g. people, companies) |
singularNoun | string | Singular display name |
pluralNoun | string | Plural display name |
createdAt | string | When the object was created |
| Parameter | Type | Required | Description |
|---|
apiSlug | string | Yes | No description |
singularNoun | string | Yes | No description |
pluralNoun | string | Yes | No description |
| Parameter | Type | Description |
|---|
objectId | string | The object ID |
apiSlug | string | The API slug (e.g. people, companies) |
singularNoun | string | Singular display name |
pluralNoun | string | Plural display name |
createdAt | string | When the object was created |
| Parameter | Type | Required | Description |
|---|
object | string | Yes | No description |
apiSlug | string | No | No description |
singularNoun | string | No | No description |
pluralNoun | string | No | No description |
| Parameter | Type | Description |
|---|
objectId | string | The object ID |
apiSlug | string | The API slug (e.g. people, companies) |
singularNoun | string | Singular display name |
pluralNoun | string | Plural display name |
createdAt | string | When the object was created |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
lists | array | Array of lists |
↳ listId | string | The list ID |
↳ apiSlug | string | The API slug for the list |
↳ name | string | The list name |
↳ parentObject | string | The parent object slug (e.g. people, companies) |
↳ workspaceAccess | string | Workspace-level access (e.g. full-access, read-only) |
↳ workspaceMemberAccess | json | Member-level access entries |
↳ createdByActor | object | The actor who created the list |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
↳ createdAt | string | When the list was created |
count | number | Number of lists returned |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
| Parameter | Type | Description |
|---|
listId | string | The list ID |
apiSlug | string | The API slug for the list |
name | string | The list name |
parentObject | string | The parent object slug (e.g. people, companies) |
workspaceAccess | string | Workspace-level access (e.g. full-access, read-only) |
workspaceMemberAccess | json | Member-level access entries |
createdByActor | object | The actor who created the list |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the list was created |
| Parameter | Type | Required | Description |
|---|
name | string | Yes | No description |
apiSlug | string | No | No description |
parentObject | string | Yes | No description |
workspaceAccess | string | No | Workspace-level access: full-access, read-and-write, or read-only (omit for private) |
workspaceMemberAccess | string | No | JSON array of member access entries, e.g. [{"workspace_member_id":"...","level":"read-and-write"}] |
| Parameter | Type | Description |
|---|
listId | string | The list ID |
apiSlug | string | The API slug for the list |
name | string | The list name |
parentObject | string | The parent object slug (e.g. people, companies) |
workspaceAccess | string | Workspace-level access (e.g. full-access, read-only) |
workspaceMemberAccess | json | Member-level access entries |
createdByActor | object | The actor who created the list |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the list was created |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
name | string | No | No description |
apiSlug | string | No | No description |
workspaceAccess | string | No | New workspace-level access: full-access, read-and-write, or read-only (omit for private) |
workspaceMemberAccess | string | No | JSON array of member access entries, e.g. [{"workspace_member_id":"...","level":"read-and-write"}] |
| Parameter | Type | Description |
|---|
listId | string | The list ID |
apiSlug | string | The API slug for the list |
name | string | The list name |
parentObject | string | The parent object slug (e.g. people, companies) |
workspaceAccess | string | Workspace-level access (e.g. full-access, read-only) |
workspaceMemberAccess | json | Member-level access entries |
createdByActor | object | The actor who created the list |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the list was created |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
filter | string | No | No description |
sorts | string | No | JSON array of sort objects (e.g. [{"attribute":"created_at","direction":"desc"}]) |
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
entries | array | Array of list entries |
↳ entryId | string | The list entry ID |
↳ listId | string | The list ID |
↳ parentRecordId | string | The parent record ID |
↳ parentObject | string | The parent object slug |
↳ createdAt | string | When the entry was created |
↳ entryValues | json | The entry attribute values (dynamic per list) |
count | number | Number of entries returned |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
entryId | string | Yes | No description |
| Parameter | Type | Description |
|---|
entryId | string | The list entry ID |
listId | string | The list ID |
parentRecordId | string | The parent record ID |
parentObject | string | The parent object slug |
createdAt | string | When the entry was created |
entryValues | json | The entry attribute values (dynamic per list) |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
parentRecordId | string | Yes | No description |
parentObject | string | Yes | No description |
entryValues | string | No | No description |
| Parameter | Type | Description |
|---|
entryId | string | The list entry ID |
listId | string | The list ID |
parentRecordId | string | The parent record ID |
parentObject | string | The parent object slug |
createdAt | string | When the entry was created |
entryValues | json | The entry attribute values (dynamic per list) |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
entryId | string | Yes | No description |
entryValues | string | Yes | No description |
| Parameter | Type | Description |
|---|
entryId | string | The list entry ID |
listId | string | The list ID |
parentRecordId | string | The parent record ID |
parentObject | string | The parent object slug |
createdAt | string | When the entry was created |
entryValues | json | The entry attribute values (dynamic per list) |
| Parameter | Type | Required | Description |
|---|
list | string | Yes | No description |
entryId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the entry was deleted |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
members | array | Array of workspace members |
↳ memberId | string | The workspace member ID |
↳ firstName | string | First name |
↳ lastName | string | Last name |
↳ avatarUrl | string | Avatar URL |
↳ emailAddress | string | Email address |
↳ accessLevel | string | Access level (admin, member, suspended) |
↳ createdAt | string | When the member was added |
count | number | Number of members returned |
| Parameter | Type | Required | Description |
|---|
memberId | string | Yes | No description |
| Parameter | Type | Description |
|---|
memberId | string | The workspace member ID |
firstName | string | First name |
lastName | string | Last name |
avatarUrl | string | Avatar URL |
emailAddress | string | Email address |
accessLevel | string | Access level (admin, member, suspended) |
createdAt | string | When the member was added |
| Parameter | Type | Required | Description |
|---|
content | string | Yes | No description |
format | string | No | No description |
authorType | string | Yes | No description |
authorId | string | Yes | No description |
list | string | Yes | No description |
entryId | string | Yes | No description |
threadId | string | No | No description |
createdAt | string | No | No description |
| Parameter | Type | Description |
|---|
commentId | string | The comment ID |
threadId | string | The thread ID |
contentPlaintext | string | The comment content as plaintext |
author | object | The comment author |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
entry | object | The list entry this comment is on |
↳ listId | string | The list ID |
↳ entryId | string | The entry ID |
record | object | The record this comment is on |
↳ objectId | string | The object ID |
↳ recordId | string | The record ID |
resolvedAt | string | When the thread was resolved |
resolvedBy | object | Who resolved the thread |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the comment was created |
| Parameter | Type | Required | Description |
|---|
commentId | string | Yes | No description |
| Parameter | Type | Description |
|---|
commentId | string | The comment ID |
threadId | string | The thread ID |
contentPlaintext | string | The comment content as plaintext |
author | object | The comment author |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
entry | object | The list entry this comment is on |
↳ listId | string | The list ID |
↳ entryId | string | The entry ID |
record | object | The record this comment is on |
↳ objectId | string | The object ID |
↳ recordId | string | The record ID |
resolvedAt | string | When the thread was resolved |
resolvedBy | object | Who resolved the thread |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the comment was created |
| Parameter | Type | Required | Description |
|---|
commentId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the comment was deleted |
| Parameter | Type | Required | Description |
|---|
recordId | string | No | No description |
object | string | No | No description |
entryId | string | No | No description |
list | string | No | No description |
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
threads | array | Array of threads |
↳ threadId | string | The thread ID |
↳ comments | array | Comments in the thread |
↳ commentId | string | The comment ID |
↳ contentPlaintext | string | Comment content |
↳ author | object | Comment author |
↳ type | string | Actor type |
↳ id | string | Actor ID |
↳ createdAt | string | When the comment was created |
↳ createdAt | string | When the thread was created |
count | number | Number of threads returned |
| Parameter | Type | Required | Description |
|---|
threadId | string | Yes | No description |
| Parameter | Type | Description |
|---|
threadId | string | The thread ID |
comments | array | Comments in the thread |
↳ type | string | The actor type (e.g. workspace-member, api-token, system) |
↳ id | string | The actor ID |
createdAt | string | When the thread was created |
| Parameter | Type | Required | Description |
|---|
limit | number | No | No description |
offset | number | No | No description |
| Parameter | Type | Description |
|---|
webhooks | array | Array of webhooks |
↳ webhookId | string | The webhook ID |
↳ targetUrl | string | The webhook target URL |
↳ subscriptions | array | Event subscriptions |
↳ eventType | string | The event type (e.g. record.created) |
↳ filter | json | Optional event filter |
↳ status | string | Webhook status (active, degraded, inactive) |
↳ createdAt | string | When the webhook was created |
count | number | Number of webhooks returned |
| Parameter | Type | Required | Description |
|---|
webhookId | string | Yes | No description |
| Parameter | Type | Description |
|---|
webhookId | string | The webhook ID |
targetUrl | string | The webhook target URL |
subscriptions | array | Event subscriptions |
↳ eventType | string | The event type (e.g. record.created) |
↳ filter | json | Optional event filter |
status | string | Webhook status (active, degraded, inactive) |
createdAt | string | When the webhook was created |
| Parameter | Type | Required | Description |
|---|
targetUrl | string | Yes | No description |
subscriptions | string | Yes | JSON array of subscriptions (e.g. [{"event_type":"record.created","filter":{"object_id":"..."}}]) |
| Parameter | Type | Description |
|---|
webhookId | string | The webhook ID |
targetUrl | string | The webhook target URL |
subscriptions | array | Event subscriptions |
↳ eventType | string | The event type (e.g. record.created) |
↳ filter | json | Optional event filter |
status | string | Webhook status (active, degraded, inactive) |
createdAt | string | When the webhook was created |
secret | string | The webhook signing secret (only returned on creation) |
| Parameter | Type | Required | Description |
|---|
webhookId | string | Yes | No description |
targetUrl | string | No | No description |
subscriptions | string | No | JSON array of subscriptions, e.g. [{"event_type":"note.created"}] |
| Parameter | Type | Description |
|---|
webhookId | string | The webhook ID |
targetUrl | string | The webhook target URL |
subscriptions | array | Event subscriptions |
↳ eventType | string | The event type (e.g. record.created) |
↳ filter | json | Optional event filter |
status | string | Webhook status (active, degraded, inactive) |
createdAt | string | When the webhook was created |
| Parameter | Type | Required | Description |
|---|
webhookId | string | Yes | No description |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the webhook was deleted |