Connect to Attio to manage CRM records (people, companies, custom objects), notes, tasks, lists, list entries, comments, workspace members, and webhooks.
Query and list records for a given object type (e.g. people, companies)
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
filter | string | Non | JSON filter object for querying records |
sorts | string | Non | JSON array of sort objects, e.g. [{"direction":"asc","attribute":"name"}] |
limit | number | Non | Maximum number of records to return (default 500) |
offset | number | Non | Number of records to skip for pagination |
| Paramètre | 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 |
Get a single record by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
recordId | string | Oui | The ID of the record to retrieve |
| Paramètre | 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 |
Create a new record in Attio for a given object type
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
values | string | Oui | JSON object of attribute values to set on the record |
| Paramètre | 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 |
Update an existing record in Attio (appends multiselect values)
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
recordId | string | Oui | The ID of the record to update |
values | string | Oui | JSON object of attribute values to update |
| Paramètre | 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 |
Delete a record from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
recordId | string | Oui | The ID of the record to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the record was deleted |
Fuzzy search for records across object types in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
query | string | Oui | The search query (max 256 characters) |
objects | string | Oui | Comma-separated object slugs to search (e.g. people,companies) |
limit | number | Non | Maximum number of results (1-25, default 25) |
| Paramètre | 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
| Paramètre | Type | Obligatoire | Description |
|---|
objectType | string | Oui | The object type slug (e.g. people, companies) |
matchingAttribute | string | Oui | The attribute slug to match on for upsert (e.g. email_addresses for people, domains for companies) |
values | string | Oui | JSON object of attribute values (e.g. {"email_addresses":[{"email_address":"test@example.com"}]}) |
| Paramètre | 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 |
List notes in Attio, optionally filtered by parent record
| Paramètre | Type | Obligatoire | Description |
|---|
parentObject | string | Non | Object type slug to filter notes by (e.g. people, companies) |
parentRecordId | string | Non | Record ID to filter notes by |
limit | number | Non | Maximum number of notes to return (default 10, max 50) |
offset | number | Non | Number of notes to skip for pagination |
| Paramètre | 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 |
Get a single note by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
noteId | string | Oui | The ID of the note to retrieve |
| Paramètre | 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 |
Create a note on a record in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
parentObject | string | Oui | The parent object type slug (e.g. people, companies) |
parentRecordId | string | Oui | The parent record ID to attach the note to |
title | string | Oui | The note title |
content | string | Oui | The note content |
format | string | Non | Content format: plaintext or markdown (default plaintext) |
createdAt | string | Non | Backdate the note creation time (ISO 8601 format) |
meetingId | string | Non | Associate the note with a meeting ID |
| Paramètre | 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 |
Delete a note from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
noteId | string | Oui | The ID of the note to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the note was deleted |
List tasks in Attio, optionally filtered by record, assignee, or completion status
| Paramètre | Type | Obligatoire | Description |
|---|
linkedObject | string | Non | Object type slug to filter tasks by (requires linkedRecordId) |
linkedRecordId | string | Non | Record ID to filter tasks by (requires linkedObject) |
assignee | string | Non | Assignee email or member ID to filter by |
isCompleted | boolean | Non | Filter by completion status |
sort | string | Non | Sort order: created_at:asc or created_at:desc |
limit | number | Non | Maximum number of tasks to return (default 500) |
offset | number | Non | Number of tasks to skip for pagination |
| Paramètre | 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 |
Get a single task by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
taskId | string | Oui | The ID of the task to retrieve |
| Paramètre | 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 |
Create a task in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
content | string | Oui | The task content (max 2000 characters) |
deadlineAt | string | Non | Deadline in ISO 8601 format (e.g. 2024-12-01T15:00:00.000Z) |
isCompleted | boolean | Non | Whether the task is completed (default false) |
linkedRecords | string | Non | JSON array of linked records (e.g. [{"target_object":"people","target_record_id":"..."}]) |
assignees | string | Non | JSON array of assignees (e.g. [{"referenced_actor_type":"workspace-member","referenced_actor_id":"..."}]) |
| Paramètre | 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 |
Update a task in Attio (deadline, completion status, linked records, assignees)
| Paramètre | Type | Obligatoire | Description |
|---|
taskId | string | Oui | The ID of the task to update |
deadlineAt | string | Non | New deadline in ISO 8601 format |
isCompleted | boolean | Non | Whether the task is completed |
linkedRecords | string | Non | JSON array of linked records |
assignees | string | Non | JSON array of assignees |
| Paramètre | 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 |
Delete a task from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
taskId | string | Oui | The ID of the task to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the task was deleted |
List all objects (system and custom) in the Attio workspace
| Paramètre | Type | Obligatoire | Description |
|---|
| Paramètre | 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 |
Get a single object by ID or slug
| Paramètre | Type | Obligatoire | Description |
|---|
object | string | Oui | The object ID or slug (e.g. people, companies) |
| Paramètre | 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 |
Create a custom object in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
apiSlug | string | Oui | The API slug for the object (e.g. projects) |
singularNoun | string | Oui | Singular display name (e.g. Project) |
pluralNoun | string | Oui | Plural display name (e.g. Projects) |
| Paramètre | 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 |
Update a custom object in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
object | string | Oui | The object ID or slug to update |
apiSlug | string | Non | New API slug |
singularNoun | string | Non | New singular display name |
pluralNoun | string | Non | New plural display name |
| Paramètre | 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 |
List all lists in the Attio workspace
| Paramètre | Type | Obligatoire | Description |
|---|
| Paramètre | 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 |
Get a single list by ID or slug
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
| Paramètre | 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 |
Create a new list in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
name | string | Oui | The list name |
apiSlug | string | Non | The API slug for the list (auto-generated from name if omitted) |
parentObject | string | Oui | The parent object slug (e.g. people, companies) |
workspaceAccess | string | Non | Workspace-level access: full-access, read-and-write, or read-only (omit for private) |
workspaceMemberAccess | string | Non | JSON array of member access entries, e.g. [{"workspace_member_id":"...","level":"read-and-write"}] |
| Paramètre | 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 |
Update a list in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug to update |
name | string | Non | New name for the list |
apiSlug | string | Non | New API slug for the list |
workspaceAccess | string | Non | New workspace-level access: full-access, read-and-write, or read-only (omit for private) |
workspaceMemberAccess | string | Non | JSON array of member access entries, e.g. [{"workspace_member_id":"...","level":"read-and-write"}] |
| Paramètre | 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 |
Query entries in an Attio list with optional filter, sort, and pagination
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
filter | string | Non | JSON filter object for querying entries |
sorts | string | Non | JSON array of sort objects (e.g. [{"attribute":"created_at","direction":"desc"}]) |
limit | number | Non | Maximum number of entries to return (default 500) |
offset | number | Non | Number of entries to skip for pagination |
| Paramètre | 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 |
Get a single list entry by ID
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
entryId | string | Oui | The entry ID |
| Paramètre | 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) |
Add a record to an Attio list as a new entry
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
parentRecordId | string | Oui | The record ID to add to the list |
parentObject | string | Oui | The object type slug of the record (e.g. people, companies) |
entryValues | string | Non | JSON object of entry attribute values |
| Paramètre | 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) |
Update entry attribute values on an Attio list entry (appends multiselect values)
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
entryId | string | Oui | The entry ID to update |
entryValues | string | Oui | JSON object of entry attribute values to update |
| Paramètre | 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) |
Remove an entry from an Attio list
| Paramètre | Type | Obligatoire | Description |
|---|
list | string | Oui | The list ID or slug |
entryId | string | Oui | The entry ID to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the entry was deleted |
List all workspace members in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
| Paramètre | 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 |
Get a single workspace member by ID
| Paramètre | Type | Obligatoire | Description |
|---|
memberId | string | Oui | The workspace member ID |
| Paramètre | 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 |
Create a comment on a list entry in Attio
| Paramètre | Type | Obligatoire | Description |
|---|
content | string | Oui | The comment content |
format | string | Non | Content format: plaintext or markdown (default plaintext) |
authorType | string | Oui | Author type (e.g. workspace-member) |
authorId | string | Oui | Author workspace member ID |
list | string | Oui | The list ID or slug the entry belongs to |
entryId | string | Oui | The entry ID to comment on |
threadId | string | Non | Thread ID to reply to (omit to start a new thread) |
createdAt | string | Non | Backdate the comment (ISO 8601 format) |
| Paramètre | 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 |
Get a single comment by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
commentId | string | Oui | The comment ID |
| Paramètre | 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 |
Delete a comment in Attio (if head of thread, deletes entire thread)
| Paramètre | Type | Obligatoire | Description |
|---|
commentId | string | Oui | The comment ID to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the comment was deleted |
List comment threads in Attio, optionally filtered by record or list entry
| Paramètre | Type | Obligatoire | Description |
|---|
recordId | string | Non | Filter by record ID (requires object) |
object | string | Non | Object slug to filter by (requires recordId) |
entryId | string | Non | Filter by list entry ID (requires list) |
list | string | Non | List ID or slug to filter by (requires entryId) |
limit | number | Non | Maximum number of threads to return (max 50) |
offset | number | Non | Number of threads to skip for pagination |
| Paramètre | 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 |
Get a single comment thread by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
threadId | string | Oui | The thread ID |
| Paramètre | 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 |
List all webhooks in the Attio workspace
| Paramètre | Type | Obligatoire | Description |
|---|
limit | number | Non | Maximum number of webhooks to return |
offset | number | Non | Number of webhooks to skip for pagination |
| Paramètre | 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 |
Get a single webhook by ID from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
webhookId | string | Oui | The webhook ID |
| Paramètre | 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 |
Create a webhook in Attio to receive event notifications
| Paramètre | Type | Obligatoire | Description |
|---|
targetUrl | string | Oui | The HTTPS URL to receive webhook events |
subscriptions | string | Oui | JSON array of subscriptions (e.g. [{"event_type":"record.created","filter":{"object_id":"..."}}]) |
| Paramètre | 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) |
Update a webhook in Attio (target URL and/or subscriptions)
| Paramètre | Type | Obligatoire | Description |
|---|
webhookId | string | Oui | The webhook ID to update |
targetUrl | string | Non | HTTPS target URL for webhook delivery |
subscriptions | string | Non | JSON array of subscriptions, e.g. [{"event_type":"note.created"}] |
| Paramètre | 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 |
Delete a webhook from Attio
| Paramètre | Type | Obligatoire | Description |
|---|
webhookId | string | Oui | The webhook ID to delete |
| Paramètre | Type | Description |
|---|
deleted | boolean | Whether the webhook was deleted |
