# Attio Docs ## Docs - [Actors](https://docs.attio.com/docs/actors.md): Keeping track of who did what - [Archiving vs deleting](https://docs.attio.com/docs/archiving-vs-deleting.md) - [Overview](https://docs.attio.com/docs/attribute-types/attribute-types.md) - [Actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference.md): References to workspace members and others - [Checkbox](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox.md): Modelling boolean values - [Currency](https://docs.attio.com/docs/attribute-types/attribute-types-currency.md): More than just numbers - [Date](https://docs.attio.com/docs/attribute-types/attribute-types-date.md): A timezone-less calendar date - [Domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain.md): An internet domain - [Email address](https://docs.attio.com/docs/attribute-types/attribute-types-email-address.md): An email address - [Interaction](https://docs.attio.com/docs/attribute-types/attribute-types-interaction.md): Calendar events and emails - [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location.md): A physical location in the world - [Number](https://docs.attio.com/docs/attribute-types/attribute-types-number.md): Quantities, sums and metrics - [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name.md): A person's name - [Phone number](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number.md): International telephone numbers - [Rating](https://docs.attio.com/docs/attribute-types/attribute-types-rating.md): Star ratings from 0 to 5 - [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference.md): Relationships and one-way links between records - [Select](https://docs.attio.com/docs/attribute-types/attribute-types-select.md): An option from a predefined list - [Status](https://docs.attio.com/docs/attribute-types/attribute-types-status.md): Similar to select attributes, originally designed for use in Lists - [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text.md): Human-readable, unconstrained text inputs - [Timestamp](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp.md): A calendar date including time information, stored in UTC - [Default values](https://docs.attio.com/docs/default-values.md) - [Authorize](https://docs.attio.com/docs/oauth/authorize.md) - [Introspect](https://docs.attio.com/docs/oauth/introspect.md) - [Token](https://docs.attio.com/docs/oauth/token.md) - [Objects and lists](https://docs.attio.com/docs/objects-and-lists.md) - [Overview](https://docs.attio.com/docs/overview.md): Start building Attio Apps - [Slugs and IDs](https://docs.attio.com/docs/slugs-and-ids.md) - [Overview](https://docs.attio.com/docs/standard-objects/standard-objects.md): Companies and people are available in all workspaces - [Companies](https://docs.attio.com/docs/standard-objects/standard-objects-companies.md): An object to represent businesses: customers, partners, peers... - [Deals](https://docs.attio.com/docs/standard-objects/standard-objects-deals.md): An object to represent deals involving people & companies - [People](https://docs.attio.com/docs/standard-objects/standard-objects-people.md): An object to represent human beings - [Users](https://docs.attio.com/docs/standard-objects/standard-objects-users.md): An object to represent users of your product - [Workspaces](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces.md): An object to group users of your product - [Users and workspaces](https://docs.attio.com/docs/users-and-workspaces.md) - [Create a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option.md): Adds a select option to a select attribute on an object or a list. Required scopes: `object_configuration:read-write`. - [Create a status](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status.md): Add a new status to a status attribute on either an object or a list. Required scopes: `object_configuration:read-write`. - [Create an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute.md): Creates a new attribute on either an object or a list. 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. - [Get an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute.md): Gets information about a single attribute on either an object or a list. Required scopes: `object_configuration:read`. - [List attributes](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes.md): Lists all attributes defined on a specific object or list. Attributes are returned in the order that they are sorted by in the UI. Required scopes: `object_configuration:read`. - [List select options](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options.md): Lists all select options for a particular attribute on either an object or a list. Required scopes: `object_configuration:read`. - [List statuses](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses.md): Lists all statuses for a particular status attribute on either an object or a list. Required scopes: `object_configuration:read`. - [Update a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option.md): Updates a select option on an attribute on either an object or a list. Required scopes: `object_configuration:read-write`. - [Update a status](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status.md): Update a status on an status attribute on either an object or a list. Required scopes: `object_configuration:read-write`. - [Update an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute.md): Updates a single attribute on a given object or list. Required scopes: `object_configuration:read-write`. - [Get call recording](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording.md): 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`. - [List call recordings](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings.md): 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`. - [Create a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment.md): 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`. - [Delete a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/delete-a-comment.md): Deletes a comment by ID. If deleting a comment at the head of a thread, all messages in the thread are also deleted. Required scopes: `comment:read-write`. - [Get a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment.md): 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`. - [Assert a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/assert-a-company-record.md): Use this endpoint to create or update company records, using a unique attribute to search for existing companies (for example, the `domains` attribute). If a company is found with the same value for the matching attribute, that company will be updated. If no company with the same value for the matching attribute is found, a new company will be created instead. If you would like to avoid matching, please use the Create company endpoint. 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`. - [Create a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/create-a-company-record.md): Creates a new company record. This endpoint will throw on conflicts of unique attributes, like `domains`. If you would prefer to update company records on conflicts, please use the Assert company record endpoint instead. Please note, the `logo_url` attribute cannot currently be set via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/delete-a-company-record.md): Deletes a single company record by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/get-a-company-record.md): Gets a single company record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List company record attribute values](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values.md): Gets all values for a given attribute on a company 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`. - [List company record entries](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries.md): List all entries, across all lists, for which this company record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List company records](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-records.md): Lists company records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/update-a-company-record.md): Use this endpoint to update company 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 [Assert company endpoint](/rest-api/endpoint-reference/standard-objects/companies/assert-a-company-record) to overwrite or remove multiselect attribute values. Please note, the `logo_url` attribute cannot currently be updated via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Assert a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record.md): Use this endpoint to create or update deal records, using a unique attribute to search for existing deals. By default, deals do not have a unique attribute, so you should add your own attribute with a unique constraint to use this API. If a deal is found with the same value for the matching attribute, that deal will be updated, otherwise a new deal will be created instead. 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`. - [Create a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record.md): Creates a new deal record. This endpoint will throw on conflicts of unique attributes, if defined. If you would prefer to update deal records on conflicts, please use the Assert deal record endpoint instead. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/delete-a-deal-record.md): Deletes a single deal record by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record.md): Gets a single deal record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List deal record attribute values](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-attribute-values.md): Gets all values for a given attribute on a deal record. Historic values can be queried using the `show_historic` query param. Historic values are sorted from oldest to newest (by `active_from`). Required scopes: `record_permission:read`, `object_configuration:read`. - [List deal record entries](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries.md): List all entries, across all lists, for which this deal record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List deal records](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-records.md): Lists deal records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/update-a-deal-record.md): Use this endpoint to update deal 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 [Assert deal endpoint](/rest-api/endpoint-reference/standard-objects/deals/assert-a-deal-record) to overwrite or remove multiselect attribute values. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Assert a list entry by parent](https://docs.attio.com/rest-api/endpoint-reference/entries/assert-a-list-entry-by-parent.md): 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`. - [Create an entry (add record to list)](https://docs.attio.com/rest-api/endpoint-reference/entries/create-an-entry-add-record-to-list.md): 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`. - [Delete a list entry](https://docs.attio.com/rest-api/endpoint-reference/entries/delete-a-list-entry.md): Deletes a single list entry by its `entry_id`. Required scopes: `list_entry:read-write`, `list_configuration:read`. - [Get a list entry](https://docs.attio.com/rest-api/endpoint-reference/entries/get-a-list-entry.md): Gets a single list entry by its `entry_id`. Required scopes: `list_entry:read`, `list_configuration:read`. - [List attribute values for a list entry](https://docs.attio.com/rest-api/endpoint-reference/entries/list-attribute-values-for-a-list-entry.md): 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`. - [List entries](https://docs.attio.com/rest-api/endpoint-reference/entries/list-entries.md): Lists entries in a given list, with the option to filter and sort results. Required scopes: `list_entry:read`, `list_configuration:read`. - [Update a list entry (append multiselect values)](https://docs.attio.com/rest-api/endpoint-reference/entries/update-a-list-entry-append-multiselect-values.md): 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`. - [Update a list entry (overwrite multiselect values)](https://docs.attio.com/rest-api/endpoint-reference/entries/update-a-list-entry-overwrite-multiselect-values.md): 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`. - [Create a list](https://docs.attio.com/rest-api/endpoint-reference/lists/create-a-list.md): 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`. - [Get a list](https://docs.attio.com/rest-api/endpoint-reference/lists/get-a-list.md): Gets a single list in your workspace that your access token has access to. Required scopes: `list_configuration:read`. - [List all lists](https://docs.attio.com/rest-api/endpoint-reference/lists/list-all-lists.md): 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`. - [Update a list](https://docs.attio.com/rest-api/endpoint-reference/lists/update-a-list.md): 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`. - [Get a meeting](https://docs.attio.com/rest-api/endpoint-reference/meetings/get-a-meeting.md): 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`. - [List meetings](https://docs.attio.com/rest-api/endpoint-reference/meetings/list-meetings.md): Lists all meetings in the workspace using a deterministic sort order. 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`. - [Identify](https://docs.attio.com/rest-api/endpoint-reference/meta/identify.md): Identify the current access token, the workspace it is linked to, and any permissions it has. - [Create a note](https://docs.attio.com/rest-api/endpoint-reference/notes/create-a-note.md): Creates a new note for a given record. Required scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`. - [Delete a note](https://docs.attio.com/rest-api/endpoint-reference/notes/delete-a-note.md): Delete a single note by ID. Required scopes: `note:read-write`. - [Get a note](https://docs.attio.com/rest-api/endpoint-reference/notes/get-a-note.md): Get a single note by ID. Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`. - [List notes](https://docs.attio.com/rest-api/endpoint-reference/notes/list-notes.md): List notes for all records or for a specific record. Required scopes: `note:read`, `object_configuration:read`, `record_permission:read`. - [Create an object](https://docs.attio.com/rest-api/endpoint-reference/objects/create-an-object.md): Creates a new custom object in your workspace. Required scopes: `object_configuration:read-write`. - [Get an object](https://docs.attio.com/rest-api/endpoint-reference/objects/get-an-object.md): Gets a single object by its `object_id` or slug. Required scopes: `object_configuration:read`. - [List objects](https://docs.attio.com/rest-api/endpoint-reference/objects/list-objects.md): Lists all system-defined and user-defined objects in your workspace. Required scopes: `object_configuration:read`. - [Update an object](https://docs.attio.com/rest-api/endpoint-reference/objects/update-an-object.md): Updates a single object. The object to be updated is identified by its `object_id`. Required scopes: `object_configuration:read-write`. - [OpenAPI](https://docs.attio.com/rest-api/endpoint-reference/openapi.md): Access the OpenAPI specification for the Attio REST API - [Assert a person Record](https://docs.attio.com/rest-api/endpoint-reference/people/assert-a-person-record.md): Use this endpoint to create or update person records, using a unique attribute to search for existing People (for example the `email_addresses` attribute). If a person is found with the same value for the matching attribute, that person will be updated. If no person with the same value for the matching attribute is found, a new person will be created instead. If you would like to avoid matching, please use the Create person endpoint. 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`. - [Create a person Record](https://docs.attio.com/rest-api/endpoint-reference/people/create-a-person-record.md): Creates a new person Record. This endpoint will throw on conflicts of unique attributes, like `email_addresses`. If you would prefer to update person records on conflicts, please use the Assert person record endpoint instead. Please note, the `avatar_url` attribute cannot currently be set via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a person Record](https://docs.attio.com/rest-api/endpoint-reference/people/delete-a-person-record.md): Deletes a single person record by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a person Record](https://docs.attio.com/rest-api/endpoint-reference/people/get-a-person-record.md): Gets a single person record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List person record attribute values](https://docs.attio.com/rest-api/endpoint-reference/people/list-person-record-attribute-values.md): Gets all values for a given attribute on a person 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`. - [List person record entries](https://docs.attio.com/rest-api/endpoint-reference/people/list-person-record-entries.md): List all entries, across all lists, for which this person record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List person records ](https://docs.attio.com/rest-api/endpoint-reference/people/list-person-records.md): Lists person records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a person Record](https://docs.attio.com/rest-api/endpoint-reference/people/update-a-person-record.md): Use this endpoint to update person 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 [Assert person endpoint](/reference/put_v2-objects-people-records) to overwrite or remove multiselect attribute values. Please note, the `avatar_url` attribute cannot currently be updated via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Assert a record](https://docs.attio.com/rest-api/endpoint-reference/records/assert-a-record.md): 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`. - [Create a record](https://docs.attio.com/rest-api/endpoint-reference/records/create-a-record.md): 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 [Assert record endpoint](/rest-api/endpoint-reference/records/assert-a-record) instead. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a record](https://docs.attio.com/rest-api/endpoint-reference/records/delete-a-record.md): Deletes a single record (e.g. a company or person) by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a record](https://docs.attio.com/rest-api/endpoint-reference/records/get-a-record.md): Gets a single person, company or other record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List record attribute values](https://docs.attio.com/rest-api/endpoint-reference/records/list-record-attribute-values.md): 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`. - [List record entries](https://docs.attio.com/rest-api/endpoint-reference/records/list-record-entries.md): List all entries, across all lists, for which this record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List records](https://docs.attio.com/rest-api/endpoint-reference/records/list-records.md): Lists people, company or other records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Search records](https://docs.attio.com/rest-api/endpoint-reference/records/search-records.md): 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 alpha and may be subject to breaking changes as we gather feedback. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a record (append multiselect values)](https://docs.attio.com/rest-api/endpoint-reference/records/update-a-record-append-multiselect-values.md): 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`. - [Update a record (overwrite multiselect values)](https://docs.attio.com/rest-api/endpoint-reference/records/update-a-record-overwrite-multiselect-values.md): 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`. - [Create a task](https://docs.attio.com/rest-api/endpoint-reference/tasks/create-a-task.md): 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`. - [Delete a task](https://docs.attio.com/rest-api/endpoint-reference/tasks/delete-a-task.md): Delete a task by ID. Required scopes: `task:read-write`. - [Get a task](https://docs.attio.com/rest-api/endpoint-reference/tasks/get-a-task.md): Get a single task by ID. Required scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`. - [List tasks](https://docs.attio.com/rest-api/endpoint-reference/tasks/list-tasks.md): 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`. - [Update a task](https://docs.attio.com/rest-api/endpoint-reference/tasks/update-a-task.md): 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`. - [Get a thread](https://docs.attio.com/rest-api/endpoint-reference/threads/get-a-thread.md): Get all comments in a 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`. - [List threads](https://docs.attio.com/rest-api/endpoint-reference/threads/list-threads.md): List threads of comments on a record or list entry. 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`. - [Get call transcript](https://docs.attio.com/rest-api/endpoint-reference/transcripts/get-call-transcript.md): 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`. - [Assert a user record](https://docs.attio.com/rest-api/endpoint-reference/users/assert-a-user-record.md): Use this endpoint to create or update user records, using a unique attribute to search for existing users (for example the `primary_email_address` attribute). If a user is found with the same value for the matching attribute, that user will be updated, otherwise a new user will be created instead. 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`. - [Create a user record](https://docs.attio.com/rest-api/endpoint-reference/users/create-a-user-record.md): Creates a new user record. This endpoint will throw on conflicts of unique attributes, like `primary_email_address`. If you would prefer to update user records on conflicts, please use the Assert user record endpoint instead. Please note, the `avatar_url` attribute cannot currently be set via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a user record](https://docs.attio.com/rest-api/endpoint-reference/users/delete-a-user-record.md): Deletes a single user record by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a user record](https://docs.attio.com/rest-api/endpoint-reference/users/get-a-user-record.md): Gets a single user record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List user record attribute values](https://docs.attio.com/rest-api/endpoint-reference/users/list-user-record-attribute-values.md): Gets all values for a given attribute on a user record. Historic values can be queried using the `show_historic` query param. Historic values are sorted from oldest to newest (by `active_from`). Required scopes: `record_permission:read`, `object_configuration:read`. - [List user record entries](https://docs.attio.com/rest-api/endpoint-reference/users/list-user-record-entries.md): List all entries, across all lists, for which this user record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List user records](https://docs.attio.com/rest-api/endpoint-reference/users/list-user-records.md): Lists user records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a user Record](https://docs.attio.com/rest-api/endpoint-reference/users/update-a-user-record.md): Use this endpoint to update user 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 [Assert user endpoint](/reference/put_v2-objects-users-records) to overwrite or remove multiselect attribute values. Please note, the `avatar_url` attribute cannot currently be updated via the API. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Create a webhook](https://docs.attio.com/rest-api/endpoint-reference/webhooks/create-a-webhook.md): Create a webhook and associated subscriptions. Required scopes: `webhook:read-write`. - [Delete a webhook](https://docs.attio.com/rest-api/endpoint-reference/webhooks/delete-a-webhook.md): Delete a webhook by ID. Required scopes: `webhook:read-write`. - [Get a webhook](https://docs.attio.com/rest-api/endpoint-reference/webhooks/get-a-webhook.md): Get a single webhook. Required scopes: `webhook:read`. - [List webhooks](https://docs.attio.com/rest-api/endpoint-reference/webhooks/list-webhooks.md): Get all of the webhooks in your workspace. Required scopes: `webhook:read`. - [Update a webhook](https://docs.attio.com/rest-api/endpoint-reference/webhooks/update-a-webhook.md): Update a webhook and associated subscriptions. Required scopes: `webhook:read-write`. - [Get a workspace member](https://docs.attio.com/rest-api/endpoint-reference/workspace-members/get-a-workspace-member.md): Gets a single workspace member by ID. Required scopes: `user_management:read`. - [List workspace members](https://docs.attio.com/rest-api/endpoint-reference/workspace-members/list-workspace-members.md): Lists all workspace members in the workspace. Required scopes: `user_management:read`. - [Assert a workspace record](https://docs.attio.com/rest-api/endpoint-reference/workspaces/assert-a-workspace-record.md): Use this endpoint to create or update workspace records, using a unique attribute to search for existing workspaces (for example the `workspace_id` attribute). If a workspace is found with the same value for the matching attribute, that workspace will be updated, otherwise a new workspace will be created instead. 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`. - [Create a workspace record](https://docs.attio.com/rest-api/endpoint-reference/workspaces/create-a-workspace-record.md): Creates a new workspace record. This endpoint will throw on conflicts of unique attributes, like `workspace_id`. If you would prefer to update workspace records on conflicts, please use the Assert workspace record endpoint instead. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [Delete a workspace record](https://docs.attio.com/rest-api/endpoint-reference/workspaces/delete-a-workspace-record.md): Deletes a single workspace record by ID. Required scopes: `object_configuration:read`, `record_permission:read-write`. - [Get a workspace record](https://docs.attio.com/rest-api/endpoint-reference/workspaces/get-a-workspace-record.md): Gets a single workspace record by its `record_id`. Required scopes: `record_permission:read`, `object_configuration:read`. - [List workspace record attribute values](https://docs.attio.com/rest-api/endpoint-reference/workspaces/list-workspace-record-attribute-values.md): Gets all values for a given attribute on a workspace record. Historic values can be queried using the `show_historic` query param. Historic values are sorted from oldest to newest (by `active_from`). Required scopes: `record_permission:read`, `object_configuration:read`. - [List workspace record entries](https://docs.attio.com/rest-api/endpoint-reference/workspaces/list-workspace-record-entries.md): List all entries, across all lists, for which this workspace record is the parent. Required scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`. - [List workspace records](https://docs.attio.com/rest-api/endpoint-reference/workspaces/list-workspace-records.md): Lists workspace records, with the option to filter and sort results. Required scopes: `record_permission:read`, `object_configuration:read`. - [Update a workspace Record](https://docs.attio.com/rest-api/endpoint-reference/workspaces/update-a-workspace-record.md): Use this endpoint to update workspace 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 [Assert workspace endpoint](/rest-api/endpoint-reference/standard-objects/workspaces/assert-a-workspace-record) to overwrite or remove multiselect attribute values. Required scopes: `record_permission:read-write`, `object_configuration:read`. - [How to authenticate requests](https://docs.attio.com/rest-api/how-to/authentication.md): How to generate access tokens and make requests - [How to apply filters and sorts](https://docs.attio.com/rest-api/how-to/filtering-and-sorting.md): Searching for just the records you need - [How to paginate API results](https://docs.attio.com/rest-api/how-to/pagination.md): Retrieving particular ranges of data - [How to handle rate limits](https://docs.attio.com/rest-api/how-to/rate-limiting.md): How to ensure your app handles rate limits gracefully - [How to configure webhooks](https://docs.attio.com/rest-api/how-to/webhooks.md): Responding to changes in real-time - [Overview](https://docs.attio.com/rest-api/overview.md): Learn about the REST API - [Connect an app to Attio through OAuth](https://docs.attio.com/rest-api/tutorials/connect-an-app-through-oauth.md): Learn how to create an OAuth 2.0 app to access Attio's REST API - [Call recording created](https://docs.attio.com/rest-api/webhook-reference/call-recording-events/call-recordingcreated.md): This event fires after a call recording has finished and its media upload is complete. - [Comment created](https://docs.attio.com/rest-api/webhook-reference/comment-events/commentcreated.md): This event is fired whenever a comment is created. - [Comment deleted](https://docs.attio.com/rest-api/webhook-reference/comment-events/commentdeleted.md): This event is fired whenever a comment is deleted. - [Comment resolved](https://docs.attio.com/rest-api/webhook-reference/comment-events/commentresolved.md): This event is fired whenever a comment is resolved. - [Comment unresolved](https://docs.attio.com/rest-api/webhook-reference/comment-events/commentunresolved.md): This event is fired whenever a comment is un-resolved. - [List attribute created](https://docs.attio.com/rest-api/webhook-reference/list-attribute-events/list-attributecreated.md): This event is fired whenever a list attribute is created (e.g. adding an "Owner" attribute). - [List attribute updated](https://docs.attio.com/rest-api/webhook-reference/list-attribute-events/list-attributeupdated.md): This event is fired whenever a list attribute is updated (e.g. when changing the name of the "Owner" attribute to "Proprietor"). - [List entry created](https://docs.attio.com/rest-api/webhook-reference/list-entry-events/list-entrycreated.md): This event is fired whenever a list entry is created (i.e. when a record is added to a list). - [List entry deleted](https://docs.attio.com/rest-api/webhook-reference/list-entry-events/list-entrydeleted.md): This event is fired whenever a list entry is deleted (i.e. when a record is removed from a list). - [List entry updated](https://docs.attio.com/rest-api/webhook-reference/list-entry-events/list-entryupdated.md): This event is fired whenever an existing list entry is updated (i.e. when a list attribute is changed for a specific list entry, e.g. when setting "Owner"). - [List created](https://docs.attio.com/rest-api/webhook-reference/list-events/listcreated.md): This event is fired whenever a list is created. - [List deleted](https://docs.attio.com/rest-api/webhook-reference/list-events/listdeleted.md): This event is fired whenever a list is deleted. - [List updated](https://docs.attio.com/rest-api/webhook-reference/list-events/listupdated.md): This event is fired whenever a list is updated (e.g. when changing the name or icon of the list). - [Note content updated](https://docs.attio.com/rest-api/webhook-reference/note-content-events/note-contentupdated.md): This event is fired whenever the content (body) of a note is updated. The `parent_object_id` refers to the object that the note references (e.g. the person object), and the `parent_record_id` refers to the record that the note references. - [Note created](https://docs.attio.com/rest-api/webhook-reference/note-events/notecreated.md): This event is fired whenever a note is created. The `parent_object_id` refers to the object that the note references (e.g. the person object), and the `parent_record_id` refers to the record that the note references. - [Note deleted](https://docs.attio.com/rest-api/webhook-reference/note-events/notedeleted.md): This event is fired whenever a note is deleted. - [Note updated](https://docs.attio.com/rest-api/webhook-reference/note-events/noteupdated.md): This event is fired whenever the title of a note is modified. Body updates do not currently trigger webhooks. - [Object attribute created](https://docs.attio.com/rest-api/webhook-reference/object-attribute-events/object-attributecreated.md): This event is fired whenever an object attribute is created (e.g. when defining a new attribute "Rating" on the company object). - [Object attribute updated](https://docs.attio.com/rest-api/webhook-reference/object-attribute-events/object-attributeupdated.md): This event is fired whenever an object attribute is updated (e.g. when renaming the "Rating" attribute to "Score" on the company object). - [Record created](https://docs.attio.com/rest-api/webhook-reference/record-events/recordcreated.md): This event is fired whenever a record is created. - [Record deleted](https://docs.attio.com/rest-api/webhook-reference/record-events/recorddeleted.md): This event is fired whenever a record is deleted. - [Record merged](https://docs.attio.com/rest-api/webhook-reference/record-events/recordmerged.md): This event is fired whenever two records are merged together. Merging copies properties from the "duplicate" record into the original record, so that the original record has the properties of both, and the duplicate record is deleted. - [Record updated](https://docs.attio.com/rest-api/webhook-reference/record-events/recordupdated.md): This event is fired whenever an attribute on a record is updated (e.g. changing the "name" field on a record). - [Task created](https://docs.attio.com/rest-api/webhook-reference/task-events/taskcreated.md): This event is fired whenever a task is created. - [Task deleted](https://docs.attio.com/rest-api/webhook-reference/task-events/taskdeleted.md): This event is fired whenever a task is deleted. - [Task updated](https://docs.attio.com/rest-api/webhook-reference/task-events/taskupdated.md): This event is fired whenever a task is updated (e.g. the assignees or deadline are changed). - [Workspace member created](https://docs.attio.com/rest-api/webhook-reference/workspace-member-events/workspace-membercreated.md): This event is fired whenever a workspace member is added to the workspace. - [](https://docs.attio.com/sdk/components/avatar.md): An avatar component for displaying profile pictures or organization logos. - [](https://docs.attio.com/sdk/components/badge.md): A colored badge of information. - [](https://docs.attio.com/sdk/components/banner.md): A component displaying important information to the user. - [