> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Attio > Attio is a fully customizable workspace for your team's relationships and workflows Attio is a fully customizable workspace for your team's relationships and workflows. `attio` · **108 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth attio run auth attio --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run attio # common commands run attio --all # every command ``` ```ts theme={"theme":"github-dark"} import { attio } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `assert-company` | Creates or updates a company record in Attio using a unique attribute to search for existing companies. | | `assert-person` | Tool to create or update person records using a unique attribute to search for existing people. | | `assert-user-record` | Creates or updates a user record in Attio using a unique attribute to search for existing users. | | `assert-workspace` | Creates or updates a workspace record in Attio using a unique attribute to search for existing workspaces. | | `create-comment` | Tool to create a new comment on a thread, record, or list entry in Attio. | | `create-company` | Creates a new company record in Attio. This endpoint will throw an error on conflicts of unique attributes like domains. | | `create-deal-record` | Tool to create a new deal record in Attio. Use when you need to track a new sales opportunity or deal. | | `create-note` | This tool creates a new note on a given record in Attio. The note can be attached to any record type (like person, company, or deal) and includes a title and content. | | `create-person` | Creates a new person record in Attio. This endpoint will throw an error on conflicts of unique attributes like email\_addresses. | | `create-record` | This tool creates a new record in Attio for a specified object type (people, companies, deals, users, workspaces, etc.). | | `create-task` | Tool to create a new task in Attio. Use when you need to add a task with content and optional deadline, assignees, or linked records. | | `create-user-record` | Creates a new user record in Attio. User records represent workspace members or users in the system. | | `create-workspace-record` | Creates a new workspace record in Attio. The workspace\_id field is required and must be unique. | | `delete-company` | Tool to delete a company record from Attio by its record\_id. | | `delete-deal` | Tool to delete a deal record from Attio by its record\_id. Use when you need to permanently remove a deal record. | | `delete-note` | This tool allows users to delete a specific note in Attio by its ID. | | `delete-person` | Tool to delete a person record from Attio by its record\_id. Use when you need to permanently remove a person record. | | `delete-record` | This tool allows you to delete a record from Attio permanently. | | `delete-user` | Tool to delete a user record from Attio by its record\_id. Use when you need to permanently remove a user record. | | `delete-workspace-record` | Tool to delete a workspace record from Attio by its record\_id. | | `find-record` | This tool allows users to find a record in Attio by either its unique ID or by searching using unique attributes. | | `get-object` | Tool to get a single object by its object\_id or slug. Use to retrieve detailed schema information about a specific object type in the Attio workspace. | | `get-record` | DEPRECATED: Use ATTIO\_FIND\_RECORD instead. Tool to get a single person, company, or other record by its record\_id in Attio. | | `get-v2-tasks` | Tool to list all tasks in the workspace. Use when you need to retrieve tasks, optionally filtering by assignee, completion status, or linked records. | | `get-v2-workspace-members` | DEPRECATED: Use ATTIO\_LIST\_WORKSPACE\_MEMBERS instead. Tool to list all workspace members in the workspace. | | Tool | What it does | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `assert-company` | Creates or updates a company record in Attio using a unique attribute to search for existing companies. | | `assert-person` | Tool to create or update person records using a unique attribute to search for existing people. | | `assert-user-record` | Creates or updates a user record in Attio using a unique attribute to search for existing users. | | `assert-workspace` | Creates or updates a workspace record in Attio using a unique attribute to search for existing workspaces. | | `create-attribute` | Tool to create a new attribute on an object or list in Attio. | | `create-comment` | Tool to create a new comment on a thread, record, or list entry in Attio. | | `create-company` | Creates a new company record in Attio. This endpoint will throw an error on conflicts of unique attributes like domains. | | `create-deal-record` | Tool to create a new deal record in Attio. Use when you need to track a new sales opportunity or deal. | | `create-entry` | DEPRECATED: Use ATTIO\_ATTIO\_POST\_V2\_LISTS\_LIST\_ENTRIES instead. | | `create-list` | Tool to create a new list in Attio. Use when you need to organize records into custom lists. | | `create-note` | This tool creates a new note on a given record in Attio. The note can be attached to any record type (like person, company, or deal) and includes a title and content. | | `create-object` | Tool to create a new custom object in your Attio workspace. Use when you need to add a new object type beyond the standard objects (people... | | `create-person` | Creates a new person record in Attio. This endpoint will throw an error on conflicts of unique attributes like email\_addresses. | | `create-record` | This tool creates a new record in Attio for a specified object type (people, companies, deals, users, workspaces, etc.). | | `create-select-option` | Tool to add a new select option to a select or multiselect attribute in Attio. | | `create-status` | Tool to add a new status to a status attribute on either an object or a list. | | `create-task` | Tool to create a new task in Attio. Use when you need to add a task with content and optional deadline, assignees, or linked records. | | `create-user-record` | Creates a new user record in Attio. User records represent workspace members or users in the system. | | `create-webhook` | Tool to create a webhook and subscribe to events in Attio. Use when you need to set up a new webhook endpoint to receive real-time event notifications. | | `create-workspace-record` | Creates a new workspace record in Attio. The workspace\_id field is required and must be unique. | | `delete-comment` | Tool to delete a comment by its comment\_id. Use when you need to remove a comment from Attio. | | `delete-company` | Tool to delete a company record from Attio by its record\_id. | | `delete-deal` | Tool to delete a deal record from Attio by its record\_id. Use when you need to permanently remove a deal record. | | `delete-entry` | Tool to delete a single list entry by its entry\_id in Attio. | | `delete-note` | This tool allows users to delete a specific note in Attio by its ID. | | `delete-person` | Tool to delete a person record from Attio by its record\_id. Use when you need to permanently remove a person record. | | `delete-record` | This tool allows you to delete a record from Attio permanently. | | `delete-task` | Tool to delete a task by its task\_id. Use when you need to remove a task from Attio. | | `delete-user` | Tool to delete a user record from Attio by its record\_id. Use when you need to permanently remove a user record. | | `delete-webhook` | Tool to delete a webhook by its webhook\_id. Use when you need to remove a webhook subscription from Attio. | | `delete-workspace-record` | Tool to delete a workspace record from Attio by its record\_id. | | `find-record` | This tool allows users to find a record in Attio by either its unique ID or by searching using unique attributes. | | `get-attribute` | Tool to get information about a single attribute on either an object or a list. | | `get-comment` | Tool to get a single comment by its comment\_id in Attio. Use when you need to retrieve detailed information about a specific comment, including its... | | `get-company` | Tool to get a single company record by its record\_id in Attio. | | `get-deal-record` | Tool to get a single deal record by its record\_id in Attio. Use when you need to retrieve detailed information about a specific deal. | | `get-list` | Tool to retrieve details of a single list in your Attio workspace. | | `get-list-entry` | Tool to get a single list entry by its entry\_id. Use when you need to retrieve detailed information about a specific entry in an Attio list. | | `get-note` | Tool to get a single note by its note\_id in Attio. Use when you need to retrieve detailed information about a specific note, including its title... | | `get-object` | Tool to get a single object by its object\_id or slug. Use to retrieve detailed schema information about a specific object type in the Attio workspace. | | `get-record` | DEPRECATED: Use ATTIO\_FIND\_RECORD instead. Tool to get a single person, company, or other record by its record\_id in Attio. | | `get-record-entries` | Tool to list all entries, across all lists, for which a record is the parent. | | `get-self` | Tool to identify the current access token, the workspace it is linked to, and any permissions it has. | | `get-task` | Tool to get a single task by its task\_id in Attio. Use when you need to retrieve detailed information about a specific task, including its content... | | `get-v2-objects-object-records-record-id` | DEPRECATED: Use ATTIO\_FIND\_RECORD instead. Tool to get a single person, company or other record by its record\_id. | | `get-v2-tasks` | Tool to list all tasks in the workspace. Use when you need to retrieve tasks, optionally filtering by assignee, completion status, or linked records. | | `get-v2-workspace-members` | DEPRECATED: Use ATTIO\_LIST\_WORKSPACE\_MEMBERS instead. Tool to list all workspace members in the workspace. | | `get-webhook` | Tool to get a single webhook by its webhook\_id in Attio. Use when you need to retrieve detailed information about a specific webhook configuration. | | `get-workspace-member` | Tool to get a single workspace member by their workspace\_member\_id. | | `get-workspace-record` | Tool to get a single workspace record by its record\_id. Use when you need to retrieve detailed information about a specific workspace. | | `list-attribute-options` | Tool to list all select options for a particular attribute on either an object or a list. | | `list-attributes` | Tool to list the attribute schema for an Attio object or list (including slugs, types, select/status config) to enable correct filtering and writes. | | `list-attribute-statuses` | Tool to list all statuses for a particular status attribute on either an object or a list. | | `list-call-recordings` | Tool to list all call recordings for a meeting in Attio. Use when you need to retrieve call recordings associated with a specific meeting. | | `list-companies` | Tool to list company records in Attio with optional filtering and sorting. | | `list-company-attribute-values` | Tool to get all values for a given attribute on a company record. | | `list-company-record-entries` | Tool to list all entries across all lists for which a company record is the parent in Attio. | | `list-deal-entries` | Tool to list all entries across all lists for which a deal record is the parent in Attio. | | `list-deal-record-attribute-values` | Tool to retrieve all values for a specified attribute on a deal record in Attio. | | `list-deal-records` | Tool to list deal records in Attio with the option to filter and sort results. | | `list-entries` | DEPRECATED: Use ATTIO\_ATTIO\_POST\_V2\_LISTS\_LIST\_ENTRIES\_QUERY instead. | | `list-list-entries` | DEPRECATED: Use ATTIO\_ATTIO\_POST\_V2\_LISTS\_LIST\_ENTRIES\_QUERY instead. | | `list-list-entry-attribute-values` | Tool to retrieve all values for a specified attribute on a list entry in Attio. | | `list-lists` | This tool retrieves all lists available in the Attio workspace, sorted as they appear in the sidebar. | | `list-meetings` | Tool to list all meetings in the workspace using a deterministic sort order. | | `list-notes` | Lists notes in Attio. Can list all notes in the workspace, or filter by parent object type and/or specific record. | | `list-objects` | This tool retrieves a list of all available objects (both system-defined and user-defined) in the Attio workspace via GET /v2/objects, returning key... | | `list-people-attribute-values` | Tool to get all values for a given attribute on a person record. | | `list-people-record-entries` | Tool to list all entries across all lists for which a person record is the parent in Attio. | | `list-record-attribute-values` | Tool to retrieve all values for a specified attribute on a record in Attio. | | `list-records` | This tool lists records from a specific object type in Attio. | | `list-threads` | Tool to list threads of comments on a record or list entry in Attio. | | `list-user-record-entries` | Tool to list all entries across all lists for which a user record is the parent in Attio. | | `list-user-records` | Tool to list user records in Attio with optional filtering and sorting. | | `list-webhooks` | Tool to get all webhooks in your Attio workspace. Use when you need to retrieve a list of configured webhooks, their subscriptions, and statuses. | | `list-workspace-members` | Tool to list workspace members (actors) so agents can reliably assign owners and resolve workspace-member IDs even when the optional Users standard object is disabled. | | `list-workspace-record-attribute-values` | Tool to retrieve all values for a specified attribute on a workspace record in Attio. | | `list-workspace-record-entries` | Tool to list all entries across all lists for which a workspace record is the parent in Attio. | | `list-workspace-records` | Tool to list workspace records with filtering and sorting options. | | `patch-record` | Tool to update people, companies, and other records by record\_id using PATCH method. | | `patch-v2-lists-list-entries-entry-id` | Tool to update list entries by entry\_id in Attio. Use when you need to modify attribute values on existing list entries. | | `people-get-person` | Tool to get a single person record by its record\_id in Attio. | | `people-list-persons` | Tool to list person records from Attio with optional filtering and sorting. | | `post-v2-lists-list-entries` | Tool to add a record to a list as a new list entry in Attio. | | `post-v2-lists-list-entries-query` | Tool to list entries in a given list, with the option to filter and sort results. | | `post-v2-objects-object-records` | DEPRECATED: Use ATTIO\_CREATE\_RECORD instead. Creates a new person, company or other record. | | `post-v2-objects-object-records-query` | Tool to list people, company or other records in Attio with the option to filter and sort results. | | `post-v2-objects-records-search` | DEPRECATED: Use ATTIO\_SEARCH\_RECORDS instead. Tool to fuzzy search for records across one or more objects in Attio. | | `put-v2-lists-list-entries` | Tool to create or update a list entry for a given parent record in Attio. | | `put-v2-lists-list-entries-entry-id` | Tool to update list entries by entry\_id in Attio using PUT method. | | `put-v2-objects-object-records` | Tool to create or update people, companies and other records in Attio using a matching attribute. | | `put-v2-objects-object-records-record-id` | Tool to update people, companies, and other records by record\_id using PUT method. | | `query-records` | Tool to query records for a specific Attio object using server-side filtering operators and sorting. | | `search-records` | Tool to fuzzy search for records across multiple objects in Attio. | | `update-attribute` | Tool to update an existing attribute by its attribute\_id or slug. | | `update-company` | Tool to update a company record in Attio by its record\_id. Use when you need to modify company attributes like name, description, domains, or team. | | `update-deal-record` | Tool to update an existing deal record in Attio by record ID. | | `update-entry` | DEPRECATED: Use ATTIO\_ATTIO\_PATCH\_V2\_LISTS\_LIST\_ENTRIES\_ENTRY\_ID instead. | | `update-list` | Tool to update an existing list in Attio. Use when you need to modify list properties like name, api\_slug, or permissions. | | `update-object` | Tool to update a single object's configuration in Attio. Use when you need to modify an object's API slug, singular noun, or plural noun. | [Open Attio in the console →](https://app.boxd.sh/integrations/detail/attio)