# Table of Contents - [Overview - Attio Docs](#overview-attio-docs) - [Actors - Attio Docs](#actors-attio-docs) - [Archiving vs deleting - Attio Docs](#archiving-vs-deleting-attio-docs) - [Actor reference - Attio Docs](#actor-reference-attio-docs) - [Overview - Attio Docs](#overview-attio-docs) - [Checkbox - Attio Docs](#checkbox-attio-docs) - [Date - Attio Docs](#date-attio-docs) - [Currency - Attio Docs](#currency-attio-docs) - [Domain - Attio Docs](#domain-attio-docs) - [Default values - Attio Docs](#default-values-attio-docs) - [Email address - Attio Docs](#email-address-attio-docs) - [Number - Attio Docs](#number-attio-docs) - [(Personal) name - Attio Docs](#-personal-name-attio-docs) - [Phone number - Attio Docs](#phone-number-attio-docs) - [Location - Attio Docs](#location-attio-docs) - [Rating - Attio Docs](#rating-attio-docs) - [Interaction - Attio Docs](#interaction-attio-docs) - [Objects and lists - Attio Docs](#objects-and-lists-attio-docs) - [Overview - Attio Docs](#overview-attio-docs) - [Authorize - Attio Docs](#authorize-attio-docs) - [Token - Attio Docs](#token-attio-docs) - [Users and workspaces - Attio Docs](#users-and-workspaces-attio-docs) - [Slugs and IDs - Attio Docs](#slugs-and-ids-attio-docs) - [Introspect - Attio Docs](#introspect-attio-docs) - [Overview - Attio Docs](#overview-attio-docs) - [Companies - Attio Docs](#companies-attio-docs) - [Users - Attio Docs](#users-attio-docs) - [Workspaces - Attio Docs](#workspaces-attio-docs) - [People - Attio Docs](#people-attio-docs) - [Deals - Attio Docs](#deals-attio-docs) - [Record reference - Attio Docs](#record-reference-attio-docs) - [Delete a comment - Attio Docs](#delete-a-comment-attio-docs) - [List call recordings - Attio Docs](#list-call-recordings-attio-docs) - [Get call recording - Attio Docs](#get-call-recording-attio-docs) - [Get a comment - Attio Docs](#get-a-comment-attio-docs) - [Text - Attio Docs](#text-attio-docs) - [Timestamp - Attio Docs](#timestamp-attio-docs) - [Create a comment - Attio Docs](#create-a-comment-attio-docs) - [Create a select option - Attio Docs](#create-a-select-option-attio-docs) - [Status - Attio Docs](#status-attio-docs) - [Create a status - Attio Docs](#create-a-status-attio-docs) - [List select options - Attio Docs](#list-select-options-attio-docs) - [Get an attribute - Attio Docs](#get-an-attribute-attio-docs) - [Delete a company record - Attio Docs](#delete-a-company-record-attio-docs) - [Delete a deal record - Attio Docs](#delete-a-deal-record-attio-docs) - [Update a status - Attio Docs](#update-a-status-attio-docs) - [List statuses - Attio Docs](#list-statuses-attio-docs) - [Update a select option - Attio Docs](#update-a-select-option-attio-docs) - [Create an attribute - Attio Docs](#create-an-attribute-attio-docs) - [List company record entries - Attio Docs](#list-company-record-entries-attio-docs) - [Select - Attio Docs](#select-attio-docs) - [List attributes - Attio Docs](#list-attributes-attio-docs) - [List deal record entries - Attio Docs](#list-deal-record-entries-attio-docs) - [Get a deal record - Attio Docs](#get-a-deal-record-attio-docs) - [List company record attribute values - Attio Docs](#list-company-record-attribute-values-attio-docs) - [Update an attribute - Attio Docs](#update-an-attribute-attio-docs) - [Assert a deal record - Attio Docs](#assert-a-deal-record-attio-docs) - [Create a deal record - Attio Docs](#create-a-deal-record-attio-docs) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) --- # Overview - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/overview#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Introduction Overview [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Attio provides a public REST API which exchanges JSON over HTTPS. In this section, you will find guidance about working with the API. To get up and running, read our guide on [how to authenticate requests](https://docs.attio.com/rest-api/guides/authentication) . From there, feel free to explore other topics or jump straight to the [reference documentation](https://docs.attio.com/rest-api/endpoint-reference) . * [Building an OAuth flow for your app](https://docs.attio.com/rest-api/tutorials/connect-an-app-through-oauth) * [Working within our rate limits](https://docs.attio.com/rest-api/guides/rate-limiting) * [Setting up and listening to webhooks](https://docs.attio.com/rest-api/guides/webhooks) * [Filtering and sorting record and entry API queries](https://docs.attio.com/rest-api/guides/filtering-and-sorting) * [Paginating API responses](https://docs.attio.com/rest-api/guides/pagination) If you’re looking to move beyond just the REST API and understand the Attio developer platform as a whole, you can find [general documentation for Attio developers here](https://docs.attio.com/docs) . Was this page helpful? YesNo [Authenticating requests](https://docs.attio.com/rest-api/guides/authentication) ⌘I --- # Actors - Attio Docs [Skip to main content](https://docs.attio.com/docs/actors#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Further reading Actors [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Types of Actors](https://docs.attio.com/docs/actors#types-of-actors) In various places in the Attio API, you will see the concept of an “actor”. An actor is something that performs actions inside Attio. A workspace member is the prime example of an actor, but you will also encounter apps and automations as actors. [​](https://docs.attio.com/docs/actors#types-of-actors) Types of Actors -------------------------------------------------------------------------- An Actor is made up of two things: a type and an ID. The current list of actors types and their corresponding ID format is as follows: * `workspace-member` - A human user who is signed into a workspace. Comes with a unique UUID. You can get further information about the workspace member, e.g. name, avatar and email address, using the [list workspace members endpoints](https://docs.attio.com/rest-api/endpoint-reference/workspace-members/list-workspace-members) . * `api-token` - An integration using the developer API. Comes with a unique UUID for the token. * `system` - An internal part of the Attio system. For example, communications intelligence updates are registered with system actors. Always comes with a `null` ID. Actors are recorded in various parts of the system. Every attribute value write, for example, includes the actor who wrote it, e.g: The actor who wrote a particular value Copy Ask AI "created_by_actor": { "type": "workspace-member", "id": "175bec0c-f06a-4c45-9962-7a7a6be28b8a" } Actors are often encountered via the “actor reference” attribute type. Every standard object includes a `created_by` attribute of this type. For more information, please see the [actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference.mdx) documentation. Was this page helpful? YesNo [Timestamp](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp) [Slugs and IDs](https://docs.attio.com/docs/slugs-and-ids) ⌘I --- # Archiving vs deleting - Attio Docs [Skip to main content](https://docs.attio.com/docs/archiving-vs-deleting#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Further reading Archiving vs deleting [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Attio uses two separate but related concepts: **archiving** and **deleting**. **Deleting** should be considered permanent. Any data you delete will eventually be removed from our servers entirely, without the ability for restoration. As such, deletes should be handled extremely carefully. When using our API, deleting occurs using the conventional REST semantics of the `DELETE` HTTP verb. **Archiving** is softer, allowing data to remain in the system, albeit in a more hidden state. The exact behaviour of archived data will depend on the object you are archiving, but the behaviour will be documented for the given endpoint. When using our API, archiving occurs by setting the `is_archived` property to `true`, and restored by setting it to `false`. Was this page helpful? YesNo [Default values](https://docs.attio.com/docs/default-values) ⌘I --- # Actor reference - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Actor reference [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#filtering) Actor references are used to link to [actors](https://docs.attio.com/docs/actors) in Attio. You’re most likely to encounter this attribute via the `created_by` attribute which is available on every object, the `owner` attribute on a deal object, or the `strongest_connection_user` on a company or person. Actor reference attributes can be single-select or multi-select. Please note, in the mobile and web clients, attributes of this type are marked as “User” attributes. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#reading-values) Reading values Actor reference values have two properties, `referenced_actor_type` and `referenced_actor_id`. The `referenced_actor_type` can be one of `"api-token"`, `"workspace-member"` or `"system"`. The `referenced_actor_id` is a UUID, or the value `null`, that uniquely identifies the actor. Example: workspace member Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "actor-reference", "referenced_actor_type": "workspace-member", "referenced_actor_id": "fbe75eb0-d704-4d12-9e41-aa187e60ed73" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#writing-values) Writing values Currently, the only type of [actor](https://docs.attio.com/docs/actors) that can be explicitly set in our API is `"workspace-member"`. We may expand this list in future. When writing references to workspace members, we allow you to identify actors by email addresses. You may do this either by passing an email address string directly, or by using an object with the key `workspace_member_email_address`. Actor reference attributes may be multi-select or single-select. When writing to multi-select attributes, you must always wrap values in an array. Single-select attributes accept unwrapped data. Using email string Single-select string Using workspace\_member\_email\_address Copy Ask AI { "owner": ["[email protected]"] } You may also specify the actor type and ID explicitly using an object with the keys `referenced_actor_type` and `referenced_actor_id`. Using workspace member ID Copy Ask AI { "owner": [\ {\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"\ }\ ] } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference#filtering) Filtering Actor reference values can only be filtered using both the `referenced_actor_type` and `referenced_actor_id` properties. If using explicit operators, only the `$eq` operator is supported. For example: Value written by workspace member Value written by API token Expanded format Copy Ask AI { "filter": { "created_by": { "referenced_actor_type": "workspace-member", "referenced_actor_id": "ec44a06c-b690-4e4f-95b6-757fb4e2f55f" } } } Was this page helpful? YesNo [Overview](https://docs.attio.com/docs/attribute-types/attribute-types) [Checkbox](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox) ⌘I --- # Overview - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Overview [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Attribute properties](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-properties) * [Attribute values](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-values) * [Attribute types](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-types) Attributes are used to model data on objects and lists. Standard objects come with a series of “system” attributes predefined, but users and developers can create and modify their own attributes as well. [​](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-properties) Attribute properties ------------------------------------------------------------------------------------------------------------- In the API, attributes are presented as a set of properties. Some attribute types have specific properties (e.g. an actor reference attribute has the `referenced_actor_type` property), but all attributes have the following properties: * `id`, which is a [composite ID](https://docs.attio.com/docs/slugs-and-ids) composed of `(workspace_id, object_id, attribute_id)` * `title`, the human-readable name of the attribute (e.g. `"Name"`) * `description`, an optional human-readable description (e.g. `"The name as registered in our database"`) * `api_slug`, a shorthand way for developers to refer to this attribute (e.g. `"name"`) * `type`, one of the enumerated types below (e.g. `"text"`) * `is_archived`, whether the [attribute has been archived](https://docs.attio.com/docs/archiving-vs-deleting) * `is_required`, whether a value is required when creating the record or list entry * `is_unique`, whether the value for this attribute is unique among all other records or list entries of that type * `is_multiselect`, whether you can write more than one value to this attribute * `is_default_value_enabled` and `default_value`, see the [default values guide](https://docs.attio.com/docs/default-values) * `created_at`, a timestamp of when this attribute was first created * `config`, an object containing specific configuration for `currency` or `record_reference` types For more information about attributes, you can find our [attribute APIs here](https://docs.attio.com/rest-api/endpoint-reference/attributes) . [​](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-values) Attribute values ----------------------------------------------------------------------------------------------------- Attribute values represent the value of the given attribute on a given record or list entry. They also have a set of common properties, that you’ll see referenced throughout this guide: * `active_from`, a timestamp showing when this value was created * `active_until`, either a timestamp (meaning the value was readable until that point in time) or `null`, meaning the value is still currently active. Most endpoints will only return active values, meaning this value is usually `null`. In special cases, such as the [list record attribute values API](https://attio.readme.io/reference/get_v2-objects-object-records-record-id-attributes-attribute-values) , you can also query historic data. * `created_by_actor`, a reference to the `id` and `type` of the [Actor](https://docs.attio.com/docs/actors) who created this value * `attribute_type`, matches the `type` property on the Attribute itself (e.g. `"text"`) [​](https://docs.attio.com/docs/attribute-types/attribute-types#attribute-types) Attribute types --------------------------------------------------------------------------------------------------- Attio currently has 17 different attribute types, and they can behave differently when creating, viewing, filtering and sorting. This guide will walk through each type, with examples of where you might find them and how to work with them: * [Actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference) * [Checkbox](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox) * [Currency](https://docs.attio.com/docs/attribute-types/attribute-types-currency) * [Date](https://docs.attio.com/docs/attribute-types/attribute-types-date) * [Domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain) * [Email address](https://docs.attio.com/docs/attribute-types/attribute-types-email-address) * [Interaction](https://docs.attio.com/docs/attribute-types/attribute-types-interaction) * [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location) * [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) * [Number](https://docs.attio.com/docs/attribute-types/attribute-types-number) * [Phone number](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number) * [Rating](https://docs.attio.com/docs/attribute-types/attribute-types-rating) * [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) * [Select](https://docs.attio.com/docs/attribute-types/attribute-types-select) * [Status](https://docs.attio.com/docs/attribute-types/attribute-types-status) * [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) * [Timestamp](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp) Was this page helpful? YesNo [Workspaces](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces) [Actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference) ⌘I --- # Checkbox - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Checkbox [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#filtering) Checkbox attributes are used to represent boolean values (`true` and `false`). In the UI, they are presented to users as a checkbox, hence the name. There are no predefined checkbox attributes on any of the standard objects. As a result, checkbox attributes will only be present when added by the user. Checkbox attributes may only be single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#reading-values) Reading values If the checkbox is checked, you’ll get the `true` property back, otherwise it will be `false`. This attribute does not support null values. Example: a checked attribute Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "checkbox", "value": true } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#writing-values) Writing values To write checkbox attribute values, you can use either the boolean values `true`/`false` or their string equivalents `"true"`/`"false"`. We support setting these values directly as raw booleans/strings, or by using an object with a single key, `value`. We only support single-select checkbox attributes, so you may always write checkbox values without wrapping the values in an array (array values containing a single element are also supported). Using boolean Using string Using array Using object Copy Ask AI { "a_custom_checkbox_attribute": true } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox#filtering) Filtering Checkbox attribute values can be filtered by true/false. If using explicit operators, only the `$eq` operator is supported. For example: Records where checkbox is checked Expanded format Copy Ask AI { "filter": { "a_custom_checkbox_attribute": true } } Was this page helpful? YesNo [Actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference) [Currency](https://docs.attio.com/docs/attribute-types/attribute-types-currency) ⌘I --- # Date - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-date#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Date [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-date#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-date#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-date#filtering) Date attributes are used to represent a single calendar year, month and day, independent of timezone. Attio exclusively works with the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, i.e. `YYYY-MM-DD` e.g. `2023-11-24`. There is only one default example of a date attribute, `foundation_date` on the company object. Date attributes can only be single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-date#reading-values) Reading values Date attributes have a single property, `value` (a string). Example: 24th November, 2023 Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "date", "value": "2023-11-24" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-date#writing-values) Writing values Date values can be written by passing an ISO 8601 date string. If hours, months, seconds or timezones are provided, they will be trimmed. For example: * `'2023'` → `'2023-01-01'` * `'2023-01'` → `'2023-01-01'` * `'2023-01-02'` → `'2023-01-02'` * `'2023-01-02T13:00'` → `'2023-01-02'` * `'2023-01-02T14:00:00'` → `'2023-01-02'` * `'2023-01-02T15:00:00.000000000'` → `'2023-01-02'` * `'2023-01-02T15:00:00.000000000+02:00'` → `'2023-01-02'` If a timezone is provided that would result in a different calendar date in UTC, the date will be coerced to UTC and then the timezone component will be trimmed. For example, the value `'2023-01-02T23:00:00-10:00'` will be returned as `'2023-01-03'`. As date values are always single-select, you may write values either by passing the date string directly, or by wrapping a single value in an array. You may also write date values using an object with a single `value` key. Using string Using object Copy Ask AI { "foundation_date": "2004-07-29" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-date#filtering) Filtering Date attribute values can be filtered by their value. You can filter for an exact date using the implicit syntax, or use the `$eq`,`$gt`,`$gte`,`$lt`,`$lte` operators with the explicit syntax. Companies founded on 2023-11-24 Companies formed after the year 2000 Copy Ask AI { "filter": { "foundation_date": "2023-11-24" } } Was this page helpful? YesNo [Currency](https://docs.attio.com/docs/attribute-types/attribute-types-currency) [Domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain) ⌘I --- # Currency - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-currency#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Currency [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Configuration](https://docs.attio.com/docs/attribute-types/attribute-types-currency#configuration) * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-currency#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-currency#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-currency#filtering) Currency attributes represent quantities of money. They are similar to number attributes, allowing storing numbers with up to four decimal places of precision, but are presented differently in the UI with a currency symbol usually alongside. Two examples of currency attributes are the `funding_raised_usd` attribute on the company object, and the `value` attribute on the deal object. There is a `currency_code` property returned from the API on each attribute value, but please note that this is shared among all attribute values of the attribute; it is not possible to override currency for a particular record or entry. Currency attributes can only be single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-currency#configuration) Configuration When creating currency attributes, you can specify two configuration properties: * `default_currency_code` - The [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code e.g. `USD` or `EUR`. All values for the attribute inherit this value. * `display_type` How the currency should be displayed across the app. See [MDN for more details](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#currencydisplay) . Specifying configuration when creating a currency attribute Copy Ask AI POST /v2/objects/:object/attributes HTTP/1.1 Authorization: Bearer <> Content-Type: application/json { "title": "Amount owed", "api_slug": "amount_owed", "type": "currency", "config": { "currency": { "default_currency_code": "USD", "display_type": "symbol" } } } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-currency#reading-values) Reading values Currency attributes have two properties, `currency_code` (string) and `currency_value` (number). This attribute does not support null values. Example: $499.00 Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "currency", "currency_value": "499.00", "currency_code": "USD" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-currency#writing-values) Writing values Currency values can be written using floating point numbers. We accept values with up to 4 decimal places of precision. You do not need to pass floating point numbers explicitly; we will automatically convert integers to their floating point equivalents. Where possible, Attio will convert strings into numbers. For example, the string `"4.99"` will be parsed as the float `4.99`. As currency attributes may only be single-select, you may always write values without wrapping in an array if preferred. We also support writing currency values using an object with a single key, `currency_value`. Using float Using string Using object Copy Ask AI { "amount_owed": 4.99 } It is not possible to specify the `currency_code` since this is inherited from the attribute. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-currency#filtering) Filtering Currency attribute values can be filtered by their value, using either JSON strings or numbers. You can filter for an exact value using the implicit syntax, or use the `$eq`,`$gt`,`$gte`,`$lt`,`$lte` operators with the explicit syntax. Finding records with an exact currency value Currency at least 500 Copy Ask AI { "filter": { "amount_owed": "399.00" } } Was this page helpful? YesNo [Checkbox](https://docs.attio.com/docs/attribute-types/attribute-types-checkbox) [Date](https://docs.attio.com/docs/attribute-types/attribute-types-date) ⌘I --- # Domain - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-domain#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Domain [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-domain#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-domain#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-domain#filtering) Domain attributes represent an internet domain, for example, “apple.com”. Attio represents domains as structured objects rather than raw strings, allowing filtering and display of specific domain properties such as the root domain. Please note that domain attributes store domains, not URLs. Any inputted values will have paths and query parameters trimmed. If you would like to store full URLs, please use a text attribute. It isn’t currently possible to create your own domain attributes, so you’ll find only the multi-select `domains` attribute on a company object. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-domain#reading-values) Reading values There are two properties on a domain attribute, `domain` and `root_domain`. The `domain` property contains the entire domain, after normalization. The `root_domain` property is the top-most part of the domain besides the public suffix. For example, the root domain of `"app.attio.com"` would be `"attio.com"`. Example: app.attio.com Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "domain", "domain": "app.attio.com", "root_domain": "attio.com" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-domain#writing-values) Writing values To write domain values, simply pass the string of the domain. The `root_domain` property will automatically be inferred from input values so there is no need to write it yourself. You may also write domain values using an object with a single key, `domain`. As the `domains` attribute is multi-select, you must always pass values wrapped in an array. Using string (single value) Using string (multiple values) Using object Copy Ask AI { "domains": ["app.attio.com"] } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-domain#filtering) Filtering Domain attribute values can be filtered by either the `root_domain` or `domain` property, and support several operators: * `$eq` for an exact match * `$not_empty` for any value present * `$contains` , `$starts_with` and `$ends_with` In implicit mode, the `domain` property is checked for equality, otherwise you can use the explicit syntax to combine the properties and operators above. Companies where domain=app.attio.com ...where subdomain=attio.com ...where domain includes attio Copy Ask AI { "filter": { "domain": "app.attio.com" } } Was this page helpful? YesNo [Date](https://docs.attio.com/docs/attribute-types/attribute-types-date) [Email address](https://docs.attio.com/docs/attribute-types/attribute-types-email-address) ⌘I --- # Default values - Attio Docs [Skip to main content](https://docs.attio.com/docs/default-values#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Further reading Default values [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Static defaults](https://docs.attio.com/docs/default-values#static-defaults) * [Dynamic defaults](https://docs.attio.com/docs/default-values#dynamic-defaults) Attribute definitions on objects and lists support default values which are used to pre-populate values on records and entries. There are two kinds of default value: static and dynamic. [​](https://docs.attio.com/docs/default-values#static-defaults) Static defaults ---------------------------------------------------------------------------------- Static values are raw values that are used directly without transformation. For example, you might want to always fill the “Deal Status” property on new entries in your “Sales” list to the value “Lead”. Static values are supported on all attribute types. The `template` property on default values must match the type of the attribute. These types are documented in our endpoint reference docs. [​](https://docs.attio.com/docs/default-values#dynamic-defaults) Dynamic defaults ------------------------------------------------------------------------------------ Dynamic values are used to generate values on the fly, depending on context. For example, you might want to fill in an “Owner” property to the current user, or set a due date to one week in the future. Dynamic values take the form of a string. The currently supported list of dynamic value templates, broken down by attribute type, is as follows: * `actor-reference` attributes, with the default value `current-user` * `timestamp` or `date` attributes, with an [ISO 8601 Duration](https://tc39.es/proposal-temporal/docs/duration.html) e.g. `“P1M”` for one month in the future Other attribute types do not currently support dynamic default values. Was this page helpful? YesNo [Slugs and IDs](https://docs.attio.com/docs/slugs-and-ids) [Archiving vs deleting](https://docs.attio.com/docs/archiving-vs-deleting) ⌘I --- # Email address - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Email address [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#filtering) Email address attributes are a string referencing an internet email address. For example, an email address might be `"[email protected]"`. Like [domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain) attributes, we do some parsing of the email domain part, as well as validating the general shape of an email address overall. It isn’t currently possible to create your own email address attributes. You’ll find only the multiselect `email_addresses` attribute on a person object, or the single attribute `email_address` attribute on the user standard object. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#reading-values) Reading values There are five properties available on this attribute: * `email_address` - the normalized form of the email address, this is the one you are most likely to use * `original_email_address` - the email as it was originally input to the system, without normalization * `email_domain` - the full domain part of the email address * `email_root_domain` - the root domain part of the email address * `email_local_specifier` - the local part of the email address Example: person@company.com Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "email-address", "email_address": "[email protected]", "original_email_address": "[email protected]", "email_domain": "company.com", "email_root_domain": "company.com", "email_local_specifier": "person" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#writing-values) Writing values Email address values can be written by passing in a string of the email you would like to write. We also support passing values with a single key, `email_address`. We strictly validate that email addresses have valid domain and local part formats. Attio will automatically infer the root domain, local specify and other properties available on read so there is no need to write them yourself. If writing to a multi-select attribute, you must wrap your input values in an array. Writing to email\_addresses Writing to email\_address Using object Copy Ask AI { "email_addresses": ["[email protected]", "[email protected]"] } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-email-address#filtering) Filtering Email attribute values can be filtered by the `email_address`, `email_domain`, `email_root_domain` and `email_local_specifier` properties, and support several operators: * `$eq` for an exact match * `$contains` , `$starts_with` and `$ends_with` In implicit mode, the `email_address` property is checked for equality, otherwise you can use the explicit syntax to combine the properties and operators above. People where email\_addresses=person@company.com ...where domain=attio.com ...where local part includes person Copy Ask AI { "filter": { "email_addresses": "[email protected]" } } Was this page helpful? YesNo [Domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain) [Interaction](https://docs.attio.com/docs/attribute-types/attribute-types-interaction) ⌘I --- # Number - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-number#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Number [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-number#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-number#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-number#filtering) Number attributes store floating point numbers with up to four decimal places of precision. An example of a number attribute is the `twitter_follower_count` attribute on both the company and person objects. Only single-select number attributes are supported. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-number#reading-values) Reading values Number attribute values have a `value` property: Example: 14 Twitter followers Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "number", "value": 14 } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-number#writing-values) Writing values To write number values, simply pass your desired number, either as an integer or a float. Alternatively, you can use an object with a single `value` property. Using number Using object Copy Ask AI { "a_custom_number_attribute": 3.1415 } Please note that `twitter_follower_count` is a system attribute and cannot be written to from the API. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-number#filtering) Filtering Numbers can be filtered by the operators `$eq`, `$gte`, `$gt`,`$lte`,`$lt`. The implicit syntax does an exact equality check: Finding records with 14 Twitter followers ... with more than 1000 followers Copy Ask AI { "filter": { "twitter_follower_count": 14 } } Was this page helpful? YesNo [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) [Phone number](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number) ⌘I --- # (Personal) name - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types (Personal) name [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#filtering) Name attributes represent a person’s name. They have three properties: `first_name`, `last_name` and `full_name`. Only the person object has a `name` attribute. Name attributes cannot be created by users. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#reading-values) Reading values All three properties are present in responses: Example: John Smith Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "personal-name", "first_name": "John", "last_name": "Smith", "full_name": "John Smith" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#writing-values) Writing values Attio provides two syntaxes for writing name values, a string syntax and an object syntax. If possible, we recommend using the object syntax as it provides full control over the name values you create. When writing values using the object syntax, all three properties must be set. Using object Copy Ask AI { "name": { "first_name": "John", "last_name": "Smith", "full_name": "John Smith" } } When writing using a string, the string must match format ‘Last name(s), First name(s)’. Text without a comma is interpreted as solely comprising the first name. Further commas will be ignored and assumed to be part of the first name. Using string Copy Ask AI { "name": "Smith, John" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name#filtering) Filtering You can filter by any of the properties, using these operators: * `$eq` * `$not_empty` * `$contains`, `$starts_with`, `$ends_with` Using the implicit filter syntax, you can search for exact matches of `full_name`, otherwise any combination of property/operator. People exactly named John Smith ...where first\_name starts with ... where last\_name is specified Copy Ask AI { "filter": { "name": "John Smith" } } Was this page helpful? YesNo [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location) [Number](https://docs.attio.com/docs/attribute-types/attribute-types-number) ⌘I --- # Phone number - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Phone number [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#filtering) Phone number attributes represent telephone numbers. They are represented in [E164 format](https://en.wikipedia.org/wiki/E.164) and always prefixed with a country code. The person object comes with a phone number attribute (`phone_numbers`), which is is a multi-select attribute, but users can also create their own phone number attributes on other objects or lists as well. There are three properties on a phone number: `original_phone_number` (as inputted by the user), `country_code` (an ISO 3166-1 alpha-2 country code) and `normalized_phone_number` (as set by Attio). All properties are represented as strings. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#reading-values) Reading values Example: a US telephone number Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "phone-number", "original_phone_number": "+15558675309", "normalized_phone_number": "+15558675309", "country_code": "US" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#writing-values) Writing values You may either write phone number values as strings or objects. For both formats, you must provide sufficient information to identify the country code of the number. For string values, the phone number must be prefixed with the area code, starting with ”+”. Object values must include both a `original_phone_number` and `country_code` property. You may pass `null` to `country_code` if an area code prefix is provided as part of `original_phone_number`. All values are validated against the E164 format. Since the `phone_numbers` attribute is multi-select, you must always pass values as part of an array. Using string Setting phone number with country Setting just the number Copy Ask AI { "phone_numbers": ["+447777777777"] } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number#filtering) Filtering Phone numbers can be filtered by equality or substrings (`$eq`,`$contains`,`$starts_with`,`$ends_with`). Note that the explicit property is called `phone_number`, internally Attio will use the normalized phone number for searching. The `country_code` property can also be filtered by `$eq` and `$not_empty`. People by exact phone number ... with US phone numbers ... with part of a phone number Copy Ask AI { "filter": { "phone_numbers": "+15558675309" } } Was this page helpful? YesNo [Number](https://docs.attio.com/docs/attribute-types/attribute-types-number) [Rating](https://docs.attio.com/docs/attribute-types/attribute-types-rating) ⌘I --- # Location - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-location#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Location [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-location#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-location#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-location#filtering) Location attributes model a physical location in the world. We store all location properties (address lines, postcode, country code, etc) on a single attribute value, rather than separate attributes. This means that when working with locations, updates must be atomic—every property must be specified, even if it is null. You’ll find an example of this attribute as `primary_location` on both person and company objects. Locations have the following properties: * `line_1` - the first line of the address, e.g. `"1 Infinite Loop"` * `line_2` - the second line of the address e.g. `"Block 1"` * `line_3`, `line_4`, same as above * `locality` - the town, neighbourhood or area, e.g. `"Cupertino"` * `region` - the state, county, province or region, e.g. `"CA"` * `postcode` - the postal or zip code, e.g. `"95014"` * `country_code` - the ISO 3166-1 alpha-2 country code, e.g. `US` * `latitude` - latitudinal coordinates, e.g. `"37.331741"` * `longitude` - longitudinal coordinates, e.g. `"-122.030333"` There are some properties which are not presently shown in the Attio app but are captured by the API—for example, address lines or postcodes. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-location#reading-values) Reading values Depending on your use case, there are various properties of a location that might be relevant for you. The API will return the full object as structured data, without attempting to format it: Example: Apple Headquarters Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "location", "line_1": "1 Infinite Loop", "line_2": null, "line_3": null, "line_4": null, "locality": "Cupertino", "region": "CA", "postcode": "95014", "country_code": "US", "latitude": "37.331741", "longitude": "-122.030333", } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-location#writing-values) Writing values When writing location values, Attio will intelligently parse strings into structured location data. json Copy Ask AI { "primary_location": "1 Infinite Loop, Cupertino, CA, 95014, US" } You may also specify each location property explicitly using an object value. When using the object syntax, we require that updates to a location attribute must specify a value for every attribute, even if it is `null`. Using object Copy Ask AI { "primary_location": { "line_1": "1 Infinite Loop", "line_2": null, "line_3": null, "line_4": null, "locality": "Cupertino", "region": "CA", "postcode": "95014", "country_code": "US", "latitude": "37.331741", "longitude": "-122.030333" } } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-location#filtering) Filtering The properties `line_1`, `line_2`, `line_3`, `line_4`, `locality`, `region` and `postcode` can all be filtered by `$eq`, `$contains`, `$starts_with` and `$ends_with` operators. The property `country_code` can be filtered by `$eq` and `$starts_with` operators. People in Cupertino, California ...where locality contains Copy Ask AI { "filter": { "primary_location": { "locality": "Cupertino", "region": "CA", "country_code": "US" } } } It is not currently possible to filter by latitude/longitude. Was this page helpful? YesNo [Interaction](https://docs.attio.com/docs/attribute-types/attribute-types-interaction) [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) ⌘I --- # Rating - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-rating#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Rating [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-rating#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-rating#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-rating#filtering) Rating attributes are a numeric value from 0 to 5. In the UI, they are presented as a proportion of 5 stars. There are no default rating attributes in Attio, but they can be created by users and in the API. Only single-select rating attributes are permitted. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-rating#reading-values) Reading values Rating attribute values have a `value` property: Example: 3 out of 5 stars Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "rating", "value": 3 } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-rating#writing-values) Writing values To write rating values, you can either pass an integer directly, or an object with a single key, `value`. As all rating attributes are single-select, you may pass the value directly or as an array containing a single element. Using number Using object Copy Ask AI { "performance": 4 } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-rating#filtering) Filtering Ratings can be filtered by the operators `$eq`, `$gte`, `$gt`,`$lte`,`$lt`. The implicit syntax does an exact equality check: Finding records rated 4 stars ... with more than 3 stars Copy Ask AI { "filter": { "performance": 4 } } Was this page helpful? YesNo [Phone number](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number) [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) ⌘I --- # Interaction - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Interaction [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#filtering) Interactions are quite a generic concept, used to model when a given actor interacted with a record in a particular way. Presently, Attio has just two types of interaction: * Email interactions (`first_email_interaction` and `last_email_interaction`) * Calendar interactions (`first_calendar_interaction`, `last_calendar_interaction` and `next_calendar_interaction`) These attributes are available on both the Company and Person objects, although they are enriched and not available on every billing plan. For more information about these attributes, [please see our Enriched data help page](https://attio.com/help/reference/data-and-syncing/enriched-data#communication-intelligence) . ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#reading-values) Reading values Interaction attribute values have an `interaction_type` property, which can be either `"email"` or `"calendar-event"`, and an `interacted_at` timestamp property in ISO8601 format. There is also an `owner_actor` property, which is an object relating the [actor](https://docs.attio.com/docs/actors) who created this interaction (this is different from the `created_by` attribute value property which could be e.g. a system actor). Example: last email received by Tom on 2023-11-25 Copy Ask AI { "active_from": "2023-11-25T15:21:06.447000000Z", "active_until": null, "created_by_actor": { "type": "system", "id": null }, "attribute_type": "interaction", "interaction_type": "email", "interacted_at": "2023-11-25T15:21:06.447000000Z", "owner_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" // Tom } } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#writing-values) Writing values It is not currently possible to write Interaction values, they are only created by the Attio system. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-interaction#filtering) Filtering There are three properties of interactions that can be used in filtering: * `owner_member_id` filters by the workspace member ID that is the `owner_actor`, this supports `$eq` and `$not_empty` operators * `interacted_at` (timestamp) supports `$eq`, `$gte`, `$gt`, `$lte` and `$lt` operators * `interaction_type` can also be filtered by `$eq` and `$not_empty` Companies ... which have had an email interaction ... with whom Tom had a recent meeting ... via email Copy Ask AI { "filter": { "last_email_interaction": { "owner_member_id": { "$not_empty": true } } } } Was this page helpful? YesNo [Email address](https://docs.attio.com/docs/attribute-types/attribute-types-email-address) [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location) ⌘I --- # Objects and lists - Attio Docs [Skip to main content](https://docs.attio.com/docs/objects-and-lists#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Core concepts Objects and lists [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Objects](https://docs.attio.com/docs/objects-and-lists#objects) * [Records](https://docs.attio.com/docs/objects-and-lists#records) * [Attributes](https://docs.attio.com/docs/objects-and-lists#attributes) * [Lists & entries](https://docs.attio.com/docs/objects-and-lists#lists-&-entries) At the core of Attio is our powerful and flexible data model, which allows you to define custom objects and lists with a wide array of attribute types. Objects can be used to model your domain entities, while lists can be used to aggregate them together and model business processes. However, both objects and lists can have their own attributes. For example, you might be using the deal object to keep track of the various deals you have in progress, but you could also create a list of deals with some additional attributes only relevant to a deal in that list. [​](https://docs.attio.com/docs/objects-and-lists#objects) Objects --------------------------------------------------------------------- Objects are the data types used to store facts about your customer. By themselves, they contain little information other than a name, but records and attributes are scoped to a single object. Attio comes with two objects enabled by default, people and companies, and three optional objects: deal, user and workspace. In relational database terms, objects are roughly tables. In object-orientated terms, they are analogous to classes. Note that an instance of an object is called a record (see below). For more information about Attio objects, please [see our help center guide](https://attio.com/help/reference/workspace/objects) . ### [​](https://docs.attio.com/docs/objects-and-lists#records) Records Records are an instantiation of an object, e.g. a specific person or a specific company. In relational database terms, a record is roughly a row in a table. In object-orientated terms, they are analogous to an object (an instantiated class). ### [​](https://docs.attio.com/docs/objects-and-lists#attributes) Attributes Attributes sit on objects and lists and describe what data we can store. Some attributes, such as the name on a person, are system defined. Others, you define yourself, either in Attio’s UI or over the API. Attributes are one of many types such as text, number, select, or currency. In relational database terms, an attribute is roughly a column in a table. [​](https://docs.attio.com/docs/objects-and-lists#lists-&-entries) Lists & entries ------------------------------------------------------------------------------------- Lists are composed of multiple rows, known as “entries”, each of which corresponds to a single record. Entries are created by adding a record to a list. Lists can be used to model a particular process. For example, you might have a “Sales” list that contains the companies that you have relationships with. Was this page helpful? YesNo [Overview](https://docs.attio.com/docs/overview) [Users and workspaces](https://docs.attio.com/docs/users-and-workspaces) ⌘I --- # Overview - Attio Docs [Skip to main content](https://docs.attio.com/docs/overview#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Get started Overview [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Attio is a revolutionary CRM platform which is highly customisable, incredibly powerful and data-driven. In these guides, you can find everything you need to build powerful integrations, automations and data pipelines on top of Attio. Our docs cover guides, examples, references and code to help you build apps and share them with Attio’s customers or for your own workspace. The Attio Developer Platform consists of two parts: [App SDK\ -------\ \ This allows developers to embed Typescript React applications within the Attio interface and run server functions with access to our REST API.](https://docs.attio.com/sdk/guides/creating-an-app) [REST API\ --------\ \ This allows developers to build apps that read and write information to and from Attio workspaces. You can also subscribe to events in realtime using webhooks.](https://docs.attio.com/rest-api/overview) You can use both the App SDK and REST API in your app to build rich experiences. Was this page helpful? YesNo [Objects and lists](https://docs.attio.com/docs/objects-and-lists) ⌘I --- # Authorize - Attio Docs [Skip to main content](https://docs.attio.com/docs/oauth/authorize#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation OAuth 2.0 Authorize [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Authorize cURL Copy Ask AI curl --request GET \ --url https://app.attio.com/authorize 200 Copy Ask AI { "302": {} } GET / authorize Try it Authorize cURL Copy Ask AI curl --request GET \ --url https://app.attio.com/authorize 200 Copy Ask AI { "302": {} } [​](https://docs.attio.com/docs/oauth/authorize#query-parameters) Query Parameters ------------------------------------------------------------------------------------- [​](https://docs.attio.com/docs/oauth/authorize#param-client-id) client\_id string required Your app’s client ID. You can find this in your app’s settings pages at [build.attio.com](https://build.attio.com/) . [​](https://docs.attio.com/docs/oauth/authorize#param-response-type) response\_type string required The response type. This should always be `"code"`. [​](https://docs.attio.com/docs/oauth/authorize#param-redirect-uri) redirect\_uri string required The URL to redirect to after the user authorizes access to your app. This URL must exactly match one of the registered redirect URLs in your app’s settings pages at [build.attio.com](https://build.attio.com/) . [​](https://docs.attio.com/docs/oauth/authorize#param-state) state string A random string to prevent CSRF attacks. Set this when starting the OAuth flow and verify it matches when the user is redirected back to your app. [​](https://docs.attio.com/docs/oauth/authorize#response) Response --------------------------------------------------------------------- [​](https://docs.attio.com/docs/oauth/authorize#param-302) 302 Redirect After the user approves the connection, they are redirected to the `redirect_uri` with a `code` query parameter. If provided, the original `state` is also included. Was this page helpful? YesNo [List workspace records](https://docs.attio.com/rest-api/endpoint-reference/workspaces/list-workspace-records) [Token](https://docs.attio.com/docs/oauth/token) ⌘I --- # Token - Attio Docs [Skip to main content](https://docs.attio.com/docs/oauth/token#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation OAuth 2.0 Token [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Token cURL Copy Ask AI curl --request POST \ --url https://app.attio.com/oauth/token 200 Copy Ask AI { "access_token": "", "token_type": "" } POST / oauth / token Try it Token cURL Copy Ask AI curl --request POST \ --url https://app.attio.com/oauth/token 200 Copy Ask AI { "access_token": "", "token_type": "" } [​](https://docs.attio.com/docs/oauth/token#request) Request --------------------------------------------------------------- [​](https://docs.attio.com/docs/oauth/token#param-client-id) client\_id string required Your app’s client ID. You can find this in your app’s settings pages at [build.attio.com](https://build.attio.com/) . [​](https://docs.attio.com/docs/oauth/token#param-client-secret) client\_secret string required Your app’s client secret. You can find this in your app’s settings pages at [build.attio.com](https://build.attio.com/) . [​](https://docs.attio.com/docs/oauth/token#param-grant-type) grant\_type string required The grant type. This should always be `"authorization_code"`. [​](https://docs.attio.com/docs/oauth/token#param-code) code string required The code which you received after being redirected from the `/authorize` endpoint. [​](https://docs.attio.com/docs/oauth/token#response) Response ----------------------------------------------------------------- [​](https://docs.attio.com/docs/oauth/token#param-access-token) access\_token string required An access token for the workspace which can be used to make authenticated requests to the Attio REST API. [​](https://docs.attio.com/docs/oauth/token#param-token-type) token\_type string default:"Bearer" required The type of token. Always `"Bearer"`. Was this page helpful? YesNo [Authorize](https://docs.attio.com/docs/oauth/authorize) [Introspect](https://docs.attio.com/docs/oauth/introspect) ⌘I --- # Users and workspaces - Attio Docs [Skip to main content](https://docs.attio.com/docs/users-and-workspaces#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Core concepts Users and workspaces [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) _Not to be confused with our standard objects [users](https://docs.attio.com/docs/standard-objects/standard-objects-users) and [workspaces](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces) _ A **user** is a login account with Attio. For example, a person who has signed up to Attio with the email `person@company.com`. A **workspace** is a company account with objects, records, lists and such. Every user has at least one workspace created when signing up for the first time. Some users will have multiple workspaces when they are members of large orgsharanisations with multiple workspaces, or for testing and development purposes. Since users can join multiple workspaces, we use the **workspace member** concept to represent a single user in a single workspace (this also encapsulates their permissions, such as whether they are an admin). All access to the Attio API is scoped to a single workspace, so you will never interact with users directly. Instead, user-level data such as email addresses are accessed through [workspace member APIs](https://docs.attio.com/rest-api/endpoint-reference/workspace-members/list-workspace-members) . Was this page helpful? YesNo [Objects and lists](https://docs.attio.com/docs/objects-and-lists) [Overview](https://docs.attio.com/docs/standard-objects/standard-objects) ⌘I --- # Slugs and IDs - Attio Docs [Skip to main content](https://docs.attio.com/docs/slugs-and-ids#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Further reading Slugs and IDs [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [IDs and Uniqueness](https://docs.attio.com/docs/slugs-and-ids#ids-and-uniqueness) * [Slugs](https://docs.attio.com/docs/slugs-and-ids#slugs) Attio uses [UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) (universally unique identifiers) to identify most of the objects in our system. We can also identify many API objects by their slug property. Slugs have the advantage that they are human-readable. For standard objects and attributes, slugs are also consistent across workspaces. [​](https://docs.attio.com/docs/slugs-and-ids#ids-and-uniqueness) IDs and Uniqueness --------------------------------------------------------------------------------------- Entities returned from Attio’s API contain an `id` property which is composed of one or more sub-IDs. The sub-IDs are each a UUID that identifies either the entity or one of its parents. Example ID from a record response Copy Ask AI { "data": { "id": { "workspace_id": "5821c091-cf04-4aab-a72a-f1646dbd6841", "object_id": "7c430b6d-fa5b-48c6-bfa7-9520c088c7bc", "record_id": "d2c2f990-3af0-4be5-808a-5605549e787f" }, // ... } } Uniqueness of an ID is only guaranteed when the ID is taken as a whole, using all sub-IDs. For example, it is unsafe to assume in the example above that the record is the only record with `record_id=”d2c2f990-3af0-4be5-808a-5605549e787f”`. The safe assumption is that the record is the only record with `record_id=”d2c2f990-3af0-4be5-808a-5605549e787f”` _and_ `object_id=”7c430b6d-fa5b-48c6-bfa7-9520c088c7bc"` _and_ `workspace_id="5821c091-cf04-4aab-a72a-f1646dbd6841"`. In practice, such collisions will be rare, but they are important to bear in mind. This is especially true if you are building large integrations which operate on the data of many workspaces. If you are only operating on data from your own workspace, you can essentially disregard the `workspace_id` key. [​](https://docs.attio.com/docs/slugs-and-ids#slugs) Slugs ------------------------------------------------------------- For ergonomics and readability, Attio’s API utilises slugs across a variety of entities such as list, objects and attributes. Path parameters, query parameters, request bodies and responses will utilise a unique slug instead of an ID where appropriate. For example, a request to the [create record endpoint](https://docs.attio.com/rest-api/endpoint-reference/records/create-a-record) accepts values keyed by either the attribute slug or attribute ID and returns values keyed by slug. Request Copy Ask AI // Slug form { "data": { "values": { "email_addresses": [\ {\ "email_address": "[email protected]"\ }\ ] } // other values... } } // ID form { "data": { "values": { "8a8ad54f-9314-4bdb-b867-e62d02a7d333": [\ {\ "email_address": "[email protected]"\ }\ ] } // other values... } } Response Copy Ask AI { "data": { "values": { "email_addresses": [\ {\ "active_from": "2023-06-01T15:49:08.524000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "api-token",\ "id": "d475d597-2900-4c93-841c-9f83154f21dc"\ },\ "original_email_address": "[email protected]",\ "email_address": "[email protected]",\ "email_domain": "bell-labs.com",\ "email_root_domain": "bell-labs.com",\ "email_local_specifier": "r.hamming",\ "attribute_type": "email-address"\ }\ ] // other values... } // other properties on data... } } Slugs are set explicitly over the API, or created automatically when entities are created through the UI. Slugs are not updated when entities are renamed through the UI, so they can be reliably used once seen. They are always unique across entities. For example, there cannot be two attributes with the same slug on the same list. Slugs of system attributes and objects are consistent across time and across workspaces. Non-system slugs are mutable, so care should be taken when modifying them in case they break any integrations relying upon them. If you would like to provide resilience against such changes, please use IDs when looking up objects instead. Slugs can be found on the following entities: * Object (`api_slug`) * Attribute (`api_slug`) * List (`api_slug`) * Status (`title`) * Select Option (`title`) * * * Was this page helpful? YesNo [Actors](https://docs.attio.com/docs/actors) [Default values](https://docs.attio.com/docs/default-values) ⌘I --- # Introspect - Attio Docs [Skip to main content](https://docs.attio.com/docs/oauth/introspect#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation OAuth 2.0 Introspect [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Introspect cURL Copy Ask AI curl --request POST \ --url https://app.attio.com/oauth/introspect 200 Copy Ask AI { "active": true, "scope": "", "client_id": "", "token_type": "", "exp": {}, "iat": 123, "sub": "", "aud": "", "iss": "", "authorized_by_workspace_member_id": "", "workspace_id": "", "workspace_name": "", "workspace_slug": "", "workspace_logo_url": {} } POST / oauth / introspect Try it Introspect cURL Copy Ask AI curl --request POST \ --url https://app.attio.com/oauth/introspect 200 Copy Ask AI { "active": true, "scope": "", "client_id": "", "token_type": "", "exp": {}, "iat": 123, "sub": "", "aud": "", "iss": "", "authorized_by_workspace_member_id": "", "workspace_id": "", "workspace_name": "", "workspace_slug": "", "workspace_logo_url": {} } Check whether an access token is valid, and if so, what scopes and identity it grants. A bearer token should be passed in the `Authorization` header of the request. [​](https://docs.attio.com/docs/oauth/introspect#response) Response ---------------------------------------------------------------------- ### [​](https://docs.attio.com/docs/oauth/introspect#inactive-token) Inactive Token [​](https://docs.attio.com/docs/oauth/introspect#param-active) active boolean required Whether the token is currently active and usable. Returns `false` for invalid or expired tokens. ### [​](https://docs.attio.com/docs/oauth/introspect#active-token) Active Token [​](https://docs.attio.com/docs/oauth/introspect#param-active-1) active boolean required Whether the token is currently active and usable. Returns `true` for valid tokens. [​](https://docs.attio.com/docs/oauth/introspect#param-scope) scope string required A space-separated list of scopes associated with this token. [​](https://docs.attio.com/docs/oauth/introspect#param-client-id) client\_id string required The app ID of the OAuth app that requested this token. [​](https://docs.attio.com/docs/oauth/introspect#param-token-type) token\_type string default:"Bearer" required The type of token. Always `"Bearer"` for tokens acquired via the OAuth 2.0 flow. [​](https://docs.attio.com/docs/oauth/introspect#param-exp) exp number | null required The time at which this token will expire, if set, as a number of seconds since January 1 1970 UTC. [​](https://docs.attio.com/docs/oauth/introspect#param-iat) iat number required The time at which this token was issued, as a number of seconds since January 1 1970 UTC. [​](https://docs.attio.com/docs/oauth/introspect#param-sub) sub string required Since Bearer tokens grant workspace-level permissions, this property contains the workspace ID. [​](https://docs.attio.com/docs/oauth/introspect#param-aud) aud string required The intended audience for this token. For Bearer tokens this is the same as the `client_id`. [​](https://docs.attio.com/docs/oauth/introspect#param-iss) iss string default:"attio.com" required The issuer of the token. Always `"attio.com"`. [​](https://docs.attio.com/docs/oauth/introspect#param-authorized-by-workspace-member-id) authorized\_by\_workspace\_member\_id string required The ID of the workspace member who authorized this token initially. [​](https://docs.attio.com/docs/oauth/introspect#param-workspace-id) workspace\_id string required The ID of the workspace the token is scoped to. [​](https://docs.attio.com/docs/oauth/introspect#param-workspace-name) workspace\_name string required The name of the workspace the token is scoped to. [​](https://docs.attio.com/docs/oauth/introspect#param-workspace-slug) workspace\_slug string required The slug of the workspace the token is scoped to. [​](https://docs.attio.com/docs/oauth/introspect#param-workspace-logo-url) workspace\_logo\_url string | null required The logo URL of the workspace the token is scoped to. Was this page helpful? YesNo [Token](https://docs.attio.com/docs/oauth/token) [Call recording created](https://docs.attio.com/rest-api/webhook-reference/call-recording-events/call-recordingcreated) ⌘I --- # Overview - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects Overview [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Attributes on every object](https://docs.attio.com/docs/standard-objects/standard-objects#attributes-on-every-object) Every Attio workspace starts with a company and person object, and admins can optionally enable the deal, user and workspace standard objects if it meets their needs. These 5 objects come with a pre-defined set of attributes. As a developer, you can rely on being able to read and write from/to these predefined (or “system”) attributes. Admins can also add custom attributes to any of these objects, or create new custom objects with custom attributes on those. Developers can interact with both standard and custom objects in the same ways, using e.g. the [assert a Record](https://docs.attio.com/rest-api/endpoint-reference/records/assert-a-record) API, but the following pages go into more detail about exactly which attributes you might find and how to read/write them for these. [​](https://docs.attio.com/docs/standard-objects/standard-objects#attributes-on-every-object) Attributes on every object --------------------------------------------------------------------------------------------------------------------------- | Attribute | Type | Writable? | Notes | | --- | --- | --- | --- | | `created_at` | Timestamp | No | When the record was created, defaults to current timestamp (see [Default values](https://docs.attio.com/docs/default-values)
) | | `created_by` (which actor created the record) | Actor reference | No | Which actor created the record, defaults to current user in web application, or the integration in API | | `record_id` | Text (UUID) | No | The unique identifier for the record, available as an attribute value to allow easy querying | Was this page helpful? YesNo [Users and workspaces](https://docs.attio.com/docs/users-and-workspaces) [Companies](https://docs.attio.com/docs/standard-objects/standard-objects-companies) ⌘I --- # Companies - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects-companies#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects Companies [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Writable attributes](https://docs.attio.com/docs/standard-objects/standard-objects-companies#writable-attributes) Company configuration Copy Ask AI api_slug: companies singular_noun: Company plural_noun: Companies The company object is available in every Attio workspace. Companies represent businesses, such as customers, partners, suppliers, etc. When creating a person, a related company record will automatically be generated or matched based on the domain of the person’s email address, but they can also be created manually via the web application or the API. Company records are enriched, which means that Attio will automatically populate additional attributes, and those enriched values cannot be overridden by API users. Additionally, some enriched attributes may be hidden from the API depending on the workspace billing plan. [​](https://docs.attio.com/docs/standard-objects/standard-objects-companies#writable-attributes) Writable attributes ----------------------------------------------------------------------------------------------------------------------- The following attributes can always be read and written using the API: | Attribute | Slug | Type | Traits | | --- | --- | --- | --- | | Domains | `domains` | [Domain](https://docs.attio.com/docs/attribute-types/attribute-types-domain) | Unique, multiselect | | Name | `name` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Description | `description` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Team | `team` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Person -> company`, multiselect | | Categories | `categories` | [Select](https://docs.attio.com/docs/attribute-types/attribute-types-select) | Multiselect | | Primary location | `primary_location` | [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location) | | | AngelList | `angellist` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Facebook | `facebook` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Instagram | `instagram` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | LinkedIn | `linkedin` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Twitter | `twitter` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Associated deals | `associated_deals` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Deal -> associated_companies` (only visible if [Deals](https://docs.attio.com/docs/standard-objects/standard-objects-deals)
activated | | Associated workspaces | `associated_workspaces` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Workspace -> company` (only visible if [Workspaces](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces)
activated) | It’s important to note that while standard attributes like `domains` have unique properties by default, you cannot create new custom attributes with a unique constraint for Company objects. Was this page helpful? YesNo [Overview](https://docs.attio.com/docs/standard-objects/standard-objects) [People](https://docs.attio.com/docs/standard-objects/standard-objects-people) ⌘I --- # Users - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects-users#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects Users [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Writeable attributes](https://docs.attio.com/docs/standard-objects/standard-objects-users#writeable-attributes) User configuration Copy Ask AI api_slug: users singular_noun: User plural_noun: Users The User object is available in every Attio workspace, but disabled by default. It can only be activated by a workspace admin, in the [Objects settings](https://app.attio.com/_/settings/data/objects) page. Users represent a user of your product. They are related to a [Person](https://docs.attio.com/docs/standard-objects/standard-objects-people) , have an email address, and an ID attribute that is defined by your system. Users are grouped together in Workspaces. [​](https://docs.attio.com/docs/standard-objects/standard-objects-users#writeable-attributes) Writeable attributes --------------------------------------------------------------------------------------------------------------------- | Attribute | Slug | Type | Traits | | --- | --- | --- | --- | | Person | `person` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Person -> associated_users` | | Primary email address | `primary_email_address` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | Required, unique - this is usually their login email in your system | | ID | `user_id` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | Required, unique - this is usually their ID in your system | | Workspaces | `workspace` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Workspace -> users` | Users can be asserted by either their `primary_email_address` or `user_id` unique attributes, or you can add your own. Was this page helpful? YesNo [Deals](https://docs.attio.com/docs/standard-objects/standard-objects-deals) [Workspaces](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces) ⌘I --- # Workspaces - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects Workspaces [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Writeable attributes](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces#writeable-attributes) Workspace configuration Copy Ask AI api_slug: workspaces singular_noun: Workspace plural_noun: Workspaces The Workspace object is available in every Attio workspace, but disabled by default. It can only be activated by a workspace admin, in the [objects settings](https://app.attio.com/_/settings/data/objects) page. Workspaces represent a grouping of users, or an account, in your product. Workspaces can belong to a [company](https://docs.attio.com/docs/standard-objects/standard-objects-companies) and have multiple [users](https://docs.attio.com/docs/standard-objects/standard-objects-users) . [​](https://docs.attio.com/docs/standard-objects/standard-objects-workspaces#writeable-attributes) Writeable attributes -------------------------------------------------------------------------------------------------------------------------- | Attribute | Slug | Type | Traits | | --- | --- | --- | --- | | ID | `workspace_id` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | Unique, required | | Name | `name` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Users | `users` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `User -> workspaces`, multiselect | | Company | `company` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Company -> associated_workspaces` | | Avatar URL | `avatar_url` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | Similar to [Company](https://docs.attio.com/docs/standard-objects/standard-objects-companies)
`logo_url` | Workspaces have a single unique attribute, `workspace_id`, which can be used for assertions, or you can add your own. Was this page helpful? YesNo [Users](https://docs.attio.com/docs/standard-objects/standard-objects-users) [Overview](https://docs.attio.com/docs/attribute-types/attribute-types) ⌘I --- # People - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects-people#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects People [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Writeable attributes](https://docs.attio.com/docs/standard-objects/standard-objects-people#writeable-attributes) People configuration Copy Ask AI api_slug: people singular_noun: Person plural_noun: People The person object is available in every Attio workspace. When creating a person, a related company record will automatically be generated or matched based on the domain of the person’s email address, but they can also be created manually via the web application or the API. Person records are enriched, which means that Attio will automatically populate additional attributes, and those values cannot be overridden by API users. Additionally, some enriched attributes may be hidden from the API depending on the workspace billing plan. [​](https://docs.attio.com/docs/standard-objects/standard-objects-people#writeable-attributes) Writeable attributes ---------------------------------------------------------------------------------------------------------------------- | Attribute | Slug | Type | Traits | | --- | --- | --- | --- | | Email addresses | `email_addresses` | [Email address](https://docs.attio.com/docs/attribute-types/attribute-types-email-address) | Unique, multiselect | | Name | `name` | [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) | | | Company | `company` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Company -> team` | | Description | `description` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Job title | `job_title` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Phone numbers | `phone_numbers` | [Phone number](https://docs.attio.com/docs/attribute-types/attribute-types-phone-number) | Multiselect | | Primary location | `primary_location` | [Location](https://docs.attio.com/docs/attribute-types/attribute-types-location) | | | AngelList | `angellist` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Facebook | `facebook` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Instagram | `instagram` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | LinkedIn | `linkedin` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Twitter | `twitter` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | | | Associated deals | `associated_deals` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Deal -> associated_people` (only available if [Deals](https://docs.attio.com/docs/standard-objects/standard-objects-deals)
activated) | | Associated users | `associated_users` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `User -> person` (only available if [Users](https://docs.attio.com/docs/standard-objects/standard-objects-users)
activated) | Was this page helpful? YesNo [Companies](https://docs.attio.com/docs/standard-objects/standard-objects-companies) [Deals](https://docs.attio.com/docs/standard-objects/standard-objects-deals) ⌘I --- # Deals - Attio Docs [Skip to main content](https://docs.attio.com/docs/standard-objects/standard-objects-deals#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Standard objects Deals [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Writeable attributes](https://docs.attio.com/docs/standard-objects/standard-objects-deals#writeable-attributes) Deal configuration Copy Ask AI api_slug: deals singular_noun: Deal plural_noun: Deal The Deal object is available in every Attio workspace, but disabled by default. It can only be activated by a workspace admin, in the [objects settings](https://app.attio.com/_/settings/data/objects) page. [​](https://docs.attio.com/docs/standard-objects/standard-objects-deals#writeable-attributes) Writeable attributes --------------------------------------------------------------------------------------------------------------------- | Attribute | Slug | Type | Traits | | --- | --- | --- | --- | | Name | `name` | [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) | Required | | Deal stage | `stage` | [Status](https://docs.attio.com/docs/attribute-types/attribute-types-status) | Required - by default one of `"Lead"`, `"In Progress"`, `"Won 🎉"`, `"Lost"` (workspaces can configure these status options) | | Deal owner | `owner` | [Actor reference](https://docs.attio.com/docs/attribute-types/attribute-types-actor-reference) | Required | | Deal value | `value` | [Currency](https://docs.attio.com/docs/attribute-types/attribute-types-currency) | Defaults to USD, can be changed | | Associated people | `associated_people` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Person -> associated_deals` | | Associated company | `associated_company` | [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) | Relationship, inverse of `Company -> associated_deals` | Note that deals do not have a unique attribute by default. This means that they cannot be automatically asserted without adding an additional unique attribute. Was this page helpful? YesNo [People](https://docs.attio.com/docs/standard-objects/standard-objects-people) [Users](https://docs.attio.com/docs/standard-objects/standard-objects-users) ⌘I --- # Record reference - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Record reference [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [A note about relationship attributes](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#a-note-about-relationship-attributes) * [Configuration](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#configuration) * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#filtering) Record reference attributes are one of the most useful types of attribute. They allow pointing to other records of the same object, or records of other objects. When combined with features such as drill-down filters, it becomes possible to deeply relate the various parts of your data model. By default, all of the standard objects have at least one record reference: * Company has `team` (people), `associated_deals` (deals) and `associated_workspaces` (workspaces) * Person has `company` (company), `associated_deals`(deals) and `associated_users` (users) * Deal has `associated_people` (people) and `associated_company` (company) * User has `person` (person) and `workspace` (workspace) * Workspace has `users` (users) and `company` (company) ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#a-note-about-relationship-attributes) A note about relationship attributes All of the example attributes above are also relationship attributes. [Relationship attributes](https://attio.com/help/reference/workspace/attributes#relationship-attributes) describe a relationship between two objects, which appear as a pair of record reference attributes, one on each object. Updating an attribute value on either of the attributes automatically updates the other attribute, which means you don’t need to explicitly update both. For example, adding a person to a company by updating the company `team` property, will also update the `company` property on that person. Currently, you will be able to see relationship attributes alongside other non-relationship record reference attributes in the API. The attribute type is still marked as `record-reference`, but there is an additional property, `relationship`, that you can use to distinguish these. If the attribute is also a relationship attribute, the `relationship` property will be an object containing an `id` property. In the example below, our company’s `team` attribute has a relationship with the person’s `company` attribute: Example attribute on a company Copy Ask AI { "id": { ... }, "title": "Team", "api_slug": "team", "type": "record-reference", "relationship": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "4e71c40b-7d35-463c-afcb-e339cfd6dbd1", // Person object "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" // "Company" attribute on Person object } }, ... } If the record reference attribute is not a relationship attribute, the `relationship` property will be set to `null`. In the web application, when setting up a relationship, the user specifies whether the relationship is many-to-many, many-to-one, one-to-many or one-to-one. It is possible to discern this relationship by looking at the `is_multiselect` property on each attribute: if `true`, this attribute is a “many”, if `false` it is a “one”. Unfortunately, at present it is not possible to create relationship attributes using the API; they can only be created in the web application and then used in the API. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#configuration) Configuration Record references are usually constrained to referencing a specific object. For example, you can’t specify a deal for the company `team` attribute. This is accomplished with the configuration property `allowed_object_ids` which is an array of object IDs (slugs are supported when writing this property): Create attribute which only supports People Copy Ask AI POST /v2/objects/:object/attributes HTTP/1.1 Authorization: Bearer <> Content-Type: application/json { "title": "Owner", "api_slug": "owner", "type": "record-reference", "config": { "record_reference": { "allowed_objects": ["person"] } } } In responses from the API, this appears as `allowed_object_ids`, like so: Attribute definition response for attribute Copy Ask AI { "id": { ... }, "title": "Team", "api_slug": "team", "type": "record-reference", "config": { "record_reference": { "allowed_object_ids": [\ "4e71c40b-7d35-463c-afcb-e339cfd6dbd1"\ ] } }, ... } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#reading-values) Reading values Record reference values have two properties, `target_object` (the `api_slug` representing what kind of object it is) and `target_record_id` (the ID of the Record). A reference to person@company.com Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "record-reference", "target_object": "people", "target_record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#writing-values) Writing values There are multiple ways to write a record reference. Since it’s such a common operation, Attio provides special write functionality if the record reference only allows a single object and that object is one of our standard objects: * If the allowed object is a company, you can use the `domains` attribute. * If the allowed object is a person, you can use the `email_addresses` attribute. * If the allowed object is a user, you can use the `user_id` attribute. * If the allowed object is a workspace, you can use the `workspace_id` attribute. Referencing a company Referencing a person Referencing a user Referencing a workspace Copy Ask AI { "associated_company": [\ {\ "domains": [{"domain": "company.com"}],\ "target_object": "companies"\ }\ ] } Furthermore, we allow writing to these attributes using string values. * If the allowed object is a company, string values will be interpreted as a domain. * If the allowed object is a person, string values will be interpreted as email addresses. * If the allowed object is a user, string values will be interpreted as `user_id` text values. * If the allowed object is a workspace, string values will be interpreted as `workspace_id` text values. Domain Domains Email Email User Users Workspace Workspaces Copy Ask AI { "associated_company": "company.com" } If the attribute is multiselect (“many”), you can also pass these as a series of values like so: It’s also possible to write record references using record IDs. Using record IDs Copy Ask AI { "associated_company": [\ {\ "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab",\ "target_object": "companies"\ }\ ] } Note that the write will fail if the target record does not exist, i.e. you can’t create the target record automatically. For example, if you tried to assert a person and referenced a company that did not exist, the request would fail. This means that you need to do your writes in reverse-order, e.g. starting with the company that the person is linked to, then creating the person. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference#filtering) Filtering Record reference values can be filtered by `target_object` and `target_record_id` using exact equality matches. Find people with a given company Find workspaces with a given user Copy Ask AI { "filter": { "company": { "target_object": "companies", "target_record_id": "99a03ff3-0435-47da-95cc-76b2caeb4dab" } } } As well as exact equality matches, record reference values also support the `$in` operator. Find people where their company's record\_id is one of several possible values Copy Ask AI { "filter": { "company": { "target_object": "companies", "target_record_id": { "$in": [\ "3aeb39cd-fed8-524e-94b8-1300549354ac",\ "8c5cd602-1297-45d2-a99c-14ae091cbac3"\ ] } } } } Record references are special, because they are also filterable using “paths”, also known as “drill-downs”. You can filter records based on attributes of the target records. `paths` is an array containing tuples of `(object type, attribute slug or ID)`, while `constraints` are applied to the attribute identified by the final path element. For example, we could construct a filter like “find me Companies which have an employee named John”: Companies with an employee named John Copy Ask AI { "filter": { "path": [\ ["companies", "team"],\ ["people", "name"]\ ], "constraints": { "first_name": { "$eq": "John" } } } } Here, we’re using the `team` attribute on a Company, which is a multi-select record reference to the person record. We then look across at those related `people`, and their `name` attribute values. Finally, since `name` is a [(personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) attribute, we can query against the `first_name` property. Paths can be more complex, and even somewhat recursive. For example, if you had a `manager` attribute on the Person object, and it pointed to another Person, you could find people by who their manager’s manager’s manager was: People by their manager's manager's manager Copy Ask AI { "filter": { "path": [\ ["people", "manager"],\ ["people", "manager"],\ ], "constraints": { "target_object": "people", "target_record_id": "managers-manager-id" } } } Was this page helpful? YesNo [Rating](https://docs.attio.com/docs/attribute-types/attribute-types-rating) [Select](https://docs.attio.com/docs/attribute-types/attribute-types-select) ⌘I --- # Delete a comment - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/comments/delete-a-comment#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Comments Delete a comment [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Delete a comment cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/comments/{comment_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} DELETE / v2 / comments / {comment\_id} Try it Delete a comment cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/comments/{comment_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/comments/delete-a-comment#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/comments/delete-a-comment#parameter-comment-id) comment\_id string required The ID of the comment to delete. Example: `"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"` #### Response 200 application/json Success Was this page helpful? YesNo [Get a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment) [List meetings](https://docs.attio.com/rest-api/endpoint-reference/meetings/list-meetings) ⌘I --- # List call recordings - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Call recordings List call recordings [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List call recordings cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/meetings/{meeting_id}/call_recordings \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "meeting_id": "cb59ab17-ad15-460c-a126-0715617c0853",\ "call_recording_id": "e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a"\ },\ "status": "completed",\ "web_url": "https://app.attio.com/salarya/calls/cb59ab17-ad15-460c-a126-0715617c0853/e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a",\ "created_by_actor": {\ "type": "workspace-member",\ "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"\ },\ "created_at": "2023-01-01T15:00:00.000000000Z"\ }\ ], "pagination": { "next_cursor": "" } } GET / v2 / meetings / {meeting\_id} / call\_recordings Try it List call recordings cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/meetings/{meeting_id}/call_recordings \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "meeting_id": "cb59ab17-ad15-460c-a126-0715617c0853",\ "call_recording_id": "e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a"\ },\ "status": "completed",\ "web_url": "https://app.attio.com/salarya/calls/cb59ab17-ad15-460c-a126-0715617c0853/e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a",\ "created_by_actor": {\ "type": "workspace-member",\ "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"\ },\ "created_at": "2023-01-01T15:00:00.000000000Z"\ }\ ], "pagination": { "next_cursor": "" } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#parameter-meeting-id) meeting\_id string required The ID of the meeting to list call recordings for. Example: `"cb59ab17-ad15-460c-a126-0715617c0853"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#parameter-limit) limit integer The maximum number of results to return. Defaults to 50 with a maximum of 200. Example: `50` [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#parameter-cursor) cursor string A cursor for pagination. Use the `next_cursor` from the previous response to get the next page of results. Minimum length: `1` Example: `"eyJkZXNjcmlwdGlvbiI6ICJ0aGlzIGlzIGEgY3Vyc29yIn0=.eM56CGbqZ6G1NHiJchTIkH4vKDr"` #### Response 200 - application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#response-data) data object\[\] required Show child attributes [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings#response-pagination) pagination object required Show child attributes Was this page helpful? YesNo [Get a meeting](https://docs.attio.com/rest-api/endpoint-reference/meetings/get-a-meeting) [Get call recording](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording) ⌘I --- # Get call recording - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Call recordings Get call recording [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Get call recording cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/meetings/{meeting_id}/call_recordings/{call_recording_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "meeting_id": "cb59ab17-ad15-460c-a126-0715617c0853", "call_recording_id": "e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a" }, "status": "completed", "web_url": "https://app.attio.com/salarya/calls/cb59ab17-ad15-460c-a126-0715617c0853/e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a", "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z" } } GET / v2 / meetings / {meeting\_id} / call\_recordings / {call\_recording\_id} Try it Get call recording cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/meetings/{meeting_id}/call_recordings/{call_recording_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "meeting_id": "cb59ab17-ad15-460c-a126-0715617c0853", "call_recording_id": "e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a" }, "status": "completed", "web_url": "https://app.attio.com/salarya/calls/cb59ab17-ad15-460c-a126-0715617c0853/e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a", "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z" } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording#parameter-meeting-id) meeting\_id string required The ID of the meeting this recording belongs to. Example: `"cb59ab17-ad15-460c-a126-0715617c0853"` [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording#parameter-call-recording-id) call\_recording\_id string required The ID of the call recording to retrieve. Example: `"e8f2a3b7-9b4d-4c5e-8a1f-3d7b2c5e8f9a"` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/get-call-recording#response-data) data object required Show child attributes Was this page helpful? YesNo [List call recordings](https://docs.attio.com/rest-api/endpoint-reference/call-recordings/list-call-recordings) [Get call transcript](https://docs.attio.com/rest-api/endpoint-reference/transcripts/get-call-transcript) ⌘I --- # Get a comment - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Comments Get a comment [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Get a comment cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/comments/{comment_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2", "content_plaintext": "Let's go ahead and close this deal, alice@attio.com.", "entry": { "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156", "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "record": { "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "resolved_at": "2023-01-01T15:00:00.000000000Z", "resolved_by": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } } GET / v2 / comments / {comment\_id} Try it Get a comment cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/comments/{comment_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2", "content_plaintext": "Let's go ahead and close this deal, alice@attio.com.", "entry": { "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156", "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "record": { "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "resolved_at": "2023-01-01T15:00:00.000000000Z", "resolved_by": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment#parameter-comment-id) comment\_id string required A UUID which identifies the comment. Example: `"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment#response-data) data object required Show child attributes Was this page helpful? YesNo [Create a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment) [Delete a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/delete-a-comment) ⌘I --- # Text - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-text#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Text [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-text#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-text#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-text#filtering) Text attributes are the most common type of attribute, and usually represent unstructured or human-readable data. They have a max size of 10mb. Examples of text attributes include the `description`, `facebook` or `instagram` attributes on company and person, or the `workspace_id` and `user_id` attributes on workspace/user. Please note that on person, the `name` attribute is a [(Personal) name](https://docs.attio.com/docs/attribute-types/attribute-types-personal-name) attribute, but on company it’s a text attribute. Text attributes are always single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-text#reading-values) Reading values Text attribute values have a single `value` property: Example: 14 Twitter followers Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "text", "value": "A long time ago in a galaxy far, far away..." } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-text#writing-values) Writing values To write text attribute values, simply pass the string that you would like to set. You may also pass an object with a single `value` property. Using string Using object Copy Ask AI { "description": "Headquartered in New York City, Waystar Royco was founded by Logan Roy and operates in 50 countries across 4 continents" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-text#filtering) Filtering Text can be filtered by the operators `$eq`, `$in`, `$contains`, `$starts_with` and `$ends_with`. The implicit syntax does an exact equality (`$eq`) check: Finding companies with an exact description ... which starts with a prefix ... which contains a keyword ...where record\_id is one of supplied values Copy Ask AI { "filter": { "description": "An exact match" } } Was this page helpful? YesNo [Status](https://docs.attio.com/docs/attribute-types/attribute-types-status) [Timestamp](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp) ⌘I --- # Timestamp - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Timestamp [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#filtering) Timestamp attributes represent a single, universal moment in time using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Time information is stored with nanosecond precision, and UTC is the assumed timezone if one is not provided. Timestamp values will always be returned in UTC. Every Attio object has a `created_at` timestamp attribute, but users can also create their own custom timestamp attributes. All timestamp attributes are single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#reading-values) Reading values Timestamp attributes have a single property, `value` (string). Example: 24th November, 2023 Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "date", "value": "2023-11-24T15:17:48.000000000Z" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#writing-values) Writing values Input values will be coerced into the full format. UTC is assumed if not specified. For example, the following input values would all be coerced to `"2023-01-02T13:00:00.000000000Z"`: * `"2023"` * `"2023-01"` * `"2023-01-02"` * `"2023-01-02T13:00"` * `"2023-01-02T13:00:00"` * `"2023-01-02T13:00:00.000000000"` * `"2023-01-02T15:00:00.000000000+02:00` To write timestamp attribute values, you should specify the `value` property: You may also pass an object with a single property, `value`. Using string Using object Copy Ask AI { "my_timestamp_attribute": "2019-01-17T15:17:48.000000000Z" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-timestamp#filtering) Filtering Timestamp attribute values can be filtered by their value. Unlike when writing timestamp values, both date and time components must be specified. You can filter for an exact timestamp using the implicit syntax, or use the `$eq`,`$gt`,`$gte`,`$lt`,`$lte` operators with the explicit syntax. Companies created on 2023-11-24 at 15:34:07.111222333Z ... after the year 2000 Copy Ask AI { "filter": { "created_at": "2023-11-24T15:34:07.111222333Z" } } Since timestamps are stored with nanosecond precision, it is often undesirable to look for an exact timestamp if you’re trying to filter records with a lower precision, e.g. in a given hour or day. Here, you should use two operators to set the upper and lower bounds of the query, remembering to use the inclusive `$gte` for the earlier bound and the exclusive `$lt` for the upper bound: Companies created between 8am and 9am ... on 24th November Copy Ask AI { "filter": { "created_at": { "$gte": "2023-11-24T08:00:00Z", "$lt": "2023-11-24T09:00:00Z" } } } Was this page helpful? YesNo [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) [Actors](https://docs.attio.com/docs/actors) ⌘I --- # Create a comment - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Comments Create a comment [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Create a comment cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/comments \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "format": "plaintext", "content": "If I put the email address of my colleague on Attio in here, e.g. alice@attio.com, they will be notified. Other emails (e.g. person@example.com) will be turned into clickable links.", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" } }' 200 400 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2", "content_plaintext": "Let's go ahead and close this deal, alice@attio.com.", "entry": { "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156", "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "record": { "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "resolved_at": "2023-01-01T15:00:00.000000000Z", "resolved_by": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } } POST / v2 / comments Try it Create a comment cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/comments \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "format": "plaintext", "content": "If I put the email address of my colleague on Attio in here, e.g. alice@attio.com, they will be notified. Other emails (e.g. person@example.com) will be turned into clickable links.", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" } }' 200 400 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2", "content_plaintext": "Let's go ahead and close this deal, alice@attio.com.", "entry": { "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156", "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "record": { "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "resolved_at": "2023-01-01T15:00:00.000000000Z", "resolved_by": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "created_at": "2023-01-01T15:00:00.000000000Z", "author": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment#body-data) data object required * Option 1 * Option 2 * Option 3 Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/comments/create-a-comment#response-data) data object required Show child attributes Was this page helpful? YesNo [Get a thread](https://docs.attio.com/rest-api/endpoint-reference/threads/get-a-thread) [Get a comment](https://docs.attio.com/rest-api/endpoint-reference/comments/get-a-comment) ⌘I --- # Create a select option - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Create a select option [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Create a select option cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Medium" } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" }, "title": "Medium", "is_archived": false } } POST / v2 / {target} / {identifier} / attributes / {attribute} / options Try it Create a select option cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Medium" } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" }, "title": "Medium", "is_archived": false } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#parameter-target) target enum required Whether the attribute is on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#parameter-identifier) identifier string required A UUID or slug to identify the object or list the select attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#parameter-attribute) attribute string required A UUID or slug to identify the attribute to create a select option on. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option#response-data) data object required Show child attributes Was this page helpful? YesNo [List select options](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options) [Update a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option) ⌘I --- # Status - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-status#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Status [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-status#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-status#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-status#filtering) Just like [select](https://docs.attio.com/docs/attribute-types/attribute-types-select) attributes, status attributes are a constrained input type, where the user must pick from a predefined list. They are used in the Attio UI to define the different columns on a kanban board, but they can also be used with objects directly. There’s only one predefined status attribute, available on the deal object as `stage`. The possible values of a status attribute are known as “statuses”, and there are [separate APIs for managing them](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses) . All status attributes are single-select. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-status#reading-values) Reading values Status values have a `status` property, which is an object describing which status was used: Example: 3 out of 5 stars Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "select", "status": { "id": { "workspace_id": "4f9a01be-3792-4ab9-926f-ca7f9005700c", "object_id": "5f1feef5-fe73-4c0e-9d97-5b0a96a7d32b", "attribute_id": "a4977b52-d367-4e28-a671-b5c4fa401fc5", "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false } } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-status#writing-values) Writing values You can find a list of available statuses using the [list statuses](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses) API. To write status values, pass the title of the status as a string. You can also pass an object with a `status` property which references either the `status_id` or the `title` of the status. If you attempt to write a value where the ID or title cannot be found, you will receive an error rather than create a new status. Using string Using object (title) Using object (status\_id) Copy Ask AI { "stage": "Lead" } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-status#filtering) Filtering Status attributes can be filtered by equality, using either the implicit syntax or the explicit one, with either the title or status ID: Finding deals in the stage ... with a status ID instead Copy Ask AI { "filter": { "stage": "In Progress" } } You can also filter for multiple possible matching values using the `$or` syntax: Finding deals in either or stage Copy Ask AI { "filter": { "$or": [\ {"stage": "In Progress"},\ {"stage": "Lead"}\ ] } } Status attributes can also be filtered based on when they were modified, using the `active_from` property. This allows automations based on when the attribute was changed. This filter supports the `$lt`, `$lte`, `$gt`, `$gte` operators: Finding deals where the stage was changed this week ... where the stage was not changed this year Copy Ask AI { "filter": { "stage": { "active_from": { "$gte": "2023-11-20" } } } } Was this page helpful? YesNo [Select](https://docs.attio.com/docs/attribute-types/attribute-types-select) [Text](https://docs.attio.com/docs/attribute-types/attribute-types-text) ⌘I --- # Create a status - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Create a status [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Create a status cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "In Progress", "celebration_enabled": true, "target_time_in_status": "P0Y0M1DT0H0M0S" } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "title": "In Progress", "is_archived": false, "celebration_enabled": false, "target_time_in_status": "P0Y0M1DT0H0M0S" } } POST / v2 / {target} / {identifier} / attributes / {attribute} / statuses Try it Create a status cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "In Progress", "celebration_enabled": true, "target_time_in_status": "P0Y0M1DT0H0M0S" } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "title": "In Progress", "is_archived": false, "celebration_enabled": false, "target_time_in_status": "P0Y0M1DT0H0M0S" } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#parameter-target) target enum required Whether the attribute is on an object or a list. Please note that company and person objects do not support status attributes at this time. Available options: `lists`, `objects` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#parameter-identifier) identifier string required A UUID or slug to identify the object or list the status attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#parameter-attribute) attribute string required A UUID or slug to identify the attribute the status will belong to. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status#response-data) data object required Show child attributes Was this page helpful? YesNo [List statuses](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses) [Update a status](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status) ⌘I --- # List select options - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes List select options [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List select options cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea"\ },\ "title": "Medium",\ "is_archived": false\ }\ ] } GET / v2 / {target} / {identifier} / attributes / {attribute} / options Try it List select options cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea"\ },\ "title": "Medium",\ "is_archived": false\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#parameter-target) target enum required Whether the attribute is on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#parameter-identifier) identifier string required A UUID or slug to identify the object or list the select attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#parameter-attribute) attribute string required A UUID or slug to identify the attribute you want to list select options on. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#parameter-show-archived) show\_archived boolean `true` if you want the results to include archived select options. Example: `true` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Update an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute) [Create a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option) ⌘I --- # Get an attribute - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Get an attribute [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Get an attribute cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } GET / v2 / {target} / {identifier} / attributes / {attribute} Try it Get an attribute cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#parameter-target) target enum required Whether the attribute is on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#parameter-identifier) identifier string required A UUID or slug to identify the object or list the attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#parameter-attribute) attribute string required A UUID or slug to identify the attribute. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute#response-data) data object required Show child attributes Example: { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } Was this page helpful? YesNo [Create an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute) [Update an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute) ⌘I --- # Delete a company record - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/companies/delete-a-company-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Companies Delete a company record [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Delete a company record cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/objects/companies/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} DELETE / v2 / objects / companies / records / {record\_id} Try it Delete a company record cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/objects/companies/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/companies/delete-a-company-record#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/companies/delete-a-company-record#parameter-record-id) record\_id string required The UUID of the company record to delete. Example: `"99a03ff3-0435-47da-95cc-76b2caeb4dab"` #### Response 200 application/json Success Was this page helpful? YesNo [Get a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/get-a-company-record) [Update a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/update-a-company-record) ⌘I --- # Delete a deal record - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/deals/delete-a-deal-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Deals Delete a deal record [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Delete a deal record cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/objects/deals/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} DELETE / v2 / objects / deals / records / {record\_id} Try it Delete a deal record cURL Copy Ask AI curl --request DELETE \ --url https://api.attio.com/v2/objects/deals/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI {} #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/deals/delete-a-deal-record#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/deals/delete-a-deal-record#parameter-record-id) record\_id string required The UUID of the deal record to delete. Example: `"1eec4535-30a1-4bc0-be24-e255d3fb5ac5"` #### Response 200 application/json Success Was this page helpful? YesNo [Get a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record) [Update a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/update-a-deal-record) ⌘I --- # Update a status - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Update a status [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Update a status cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses/{status} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "In Progress", "celebration_enabled": true, "target_time_in_status": "P0Y0M1DT0H0M0S", "is_archived": false } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "title": "In Progress", "is_archived": false, "celebration_enabled": false, "target_time_in_status": "P0Y0M1DT0H0M0S" } } PATCH / v2 / {target} / {identifier} / attributes / {attribute} / statuses / {status} Try it Update a status cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses/{status} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "In Progress", "celebration_enabled": true, "target_time_in_status": "P0Y0M1DT0H0M0S", "is_archived": false } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "title": "In Progress", "is_archived": false, "celebration_enabled": false, "target_time_in_status": "P0Y0M1DT0H0M0S" } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#parameter-target) target enum required Whether the attribute is on an object or a list. Please note that company and person objects do not support status attributes at this time. Available options: `lists`, `objects` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#parameter-identifier) identifier string required A UUID or slug to identify the object or list the status attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#parameter-attribute) attribute string required A UUID or slug to identify the attribute to update the status on. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#parameter-status) status string required A UUID or status title to identify the status to update. Example: `"In Progress"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-status#response-data) data object required Show child attributes Was this page helpful? YesNo [Create a status](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status) [List records](https://docs.attio.com/rest-api/endpoint-reference/records/list-records) ⌘I --- # List statuses - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes List statuses [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List statuses cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "title": "In Progress",\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": "P0Y0M1DT0H0M0S"\ }\ ] } GET / v2 / {target} / {identifier} / attributes / {attribute} / statuses Try it List statuses cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/statuses \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "title": "In Progress",\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": "P0Y0M1DT0H0M0S"\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#parameter-target) target enum required Whether the attribute is on an object or a list. Please note that the company and people objects do not support status attributes at this time. Available options: `lists`, `objects` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#parameter-identifier) identifier string required A UUID or slug to identify the object or list the status attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#parameter-attribute) attribute string required A UUID or slug to identify the attribute you want to list statuses on. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#parameter-show-archived) show\_archived boolean default:false `true` if you want the results to include archived statuses. See our [archiving guide](https://docs.attio.com/docs/archiving-vs-deleting) for more information on archiving. Example: `true` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Update a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option) [Create a status](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-status) ⌘I --- # Update a select option - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Update a select option [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Update a select option cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options/{option} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Medium", "is_archived": false } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" }, "title": "Medium", "is_archived": false } } PATCH / v2 / {target} / {identifier} / attributes / {attribute} / options / {option} Try it Update a select option cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute}/options/{option} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Medium", "is_archived": false } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96", "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" }, "title": "Medium", "is_archived": false } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#parameter-target) target enum required Whether the attribute is on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#parameter-identifier) identifier string required A UUID or slug to identify the object or list the select attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#parameter-attribute) attribute string required A UUID or slug to identify the select attribute. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#parameter-option) option string required A UUID or select option title to identify the select option you would like to update. Example: `"Medium"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-a-select-option#response-data) data object required Show child attributes Was this page helpful? YesNo [Create a select option](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-a-select-option) [List statuses](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-statuses) ⌘I --- # Create an attribute - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Create an attribute [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Create an attribute cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Your Attribute", "description": "Lorem ipsum", "api_slug": "my-attribute", "type": "text", "is_required": true, "is_unique": true, "is_multiselect": true, "default_value": { "type": "static", "template": [\ {\ "value": 5\ }\ ] }, "config": { "currency": { "default_currency_code": "USD", "display_type": "symbol" }, "record_reference": { "allowed_objects": [\ "people"\ ] } } } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } POST / v2 / {target} / {identifier} / attributes Try it Create an attribute cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/{target}/{identifier}/attributes \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Your Attribute", "description": "Lorem ipsum", "api_slug": "my-attribute", "type": "text", "is_required": true, "is_unique": true, "is_multiselect": true, "default_value": { "type": "static", "template": [\ {\ "value": 5\ }\ ] }, "config": { "currency": { "default_currency_code": "USD", "display_type": "symbol" }, "record_reference": { "allowed_objects": [\ "people"\ ] } } } }' 200 400 404 409 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#parameter-target) target enum required Whether the attribute is to be created on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#parameter-identifier) identifier string required A UUID or slug to identify the object or list the attribute belongs to. Example: `"97052eb9-e65e-443f-a297-f2d9a4a7f795"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute#response-data) data object required Show child attributes Example: { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } }} Was this page helpful? YesNo [List attributes](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes) [Get an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute) ⌘I --- # List company record entries - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Companies List company record entries [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List company record entries cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/companies/records/{record_id}/entries \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",\ "list_api_slug": "sales-prospects",\ "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",\ "created_at": "2022-11-21T13:22:49.061281000Z"\ }\ ] } GET / v2 / objects / companies / records / {record\_id} / entries Try it List company record entries cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/companies/records/{record_id}/entries \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",\ "list_api_slug": "sales-prospects",\ "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",\ "created_at": "2022-11-21T13:22:49.061281000Z"\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#parameter-record-id) record\_id string required A UUID of the company record to fetch entries for. Example: `"99a03ff3-0435-47da-95cc-76b2caeb4dab"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#parameter-limit) limit integer The maximum number of results to return. The default is `100` and the maximum is `1000`. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `10` [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#parameter-offset) offset integer The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `5` #### Response 200 - application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [List company record attribute values](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values) [List user records](https://docs.attio.com/rest-api/endpoint-reference/users/list-user-records) ⌘I --- # Select - Attio Docs [Skip to main content](https://docs.attio.com/docs/attribute-types/attribute-types-select#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attribute types Select [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) On this page * [Reading values](https://docs.attio.com/docs/attribute-types/attribute-types-select#reading-values) * [Writing values](https://docs.attio.com/docs/attribute-types/attribute-types-select#writing-values) * [Filtering](https://docs.attio.com/docs/attribute-types/attribute-types-select#filtering) Select attributes are a constrained input type, where the user must pick from a predefined list. Company has several select attributes (they are mostly [enriched attributes](https://attio.com/help/reference/data-and-syncing/enriched-data) ): `categories`, `estimated_arr_usd` and `employee_range`. `strongest_connection_strength` is also available on both person and company. Attio provides a [separate API for managing the select options available](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options) . Select attributes may be either single-select or multi-select. In the API, these two variants are represented using the same underlying type, select. However, in web and mobile clients, users will see these attributes as two separate types: select and multi-select. Please note that select attributes cannot be configured to be unique. ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-select#reading-values) Reading values Select attribute values have an `option` property, which is an object describing which select option was used: Example: 3 out of 5 stars Copy Ask AI { "active_from": "2023-04-03T15:21:06.447000000Z", "active_until": null, "created_by_actor": {...}, "attribute_type": "select", "option": { "id": { "workspace_id": "4f9a01be-3792-4ab9-926f-ca7f9005700c", "object_id": "5f1feef5-fe73-4c0e-9d97-5b0a96a7d32b", "attribute_id": "a4977b52-d367-4e28-a671-b5c4fa401fc5", "option_id": "14938464-cae9-4e50-8856-0fb584844f24" }, "title": "Aerospace & Defense", "is_archived": false } } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-select#writing-values) Writing values You can find a list of available options using the [list select options](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options) API. To write select values, pass the title of the select option as a string. If it’s a multi-value select attribute, you’ll need to pass an array. You can also pass an object with an `option` property, which references either the `option_id` or the `title` of the select option. If you attempt to write a value where the ID or title cannot be found, you will receive an error rather than create a new select option. Using string Multiple values Using object (title) Using object (option\_id) Copy Ask AI { "categories": ["3D Printing"] } ### [​](https://docs.attio.com/docs/attribute-types/attribute-types-select#filtering) Filtering Select attributes can be filtered by equality, using either the implicit syntax or the explicit one: Finding companies in the category ... with an option ID instead Copy Ask AI { "filter": { "categories": "Aerospace & Defense" } } It’s also possible to use `$or` to find records which match one of several categories: Find Companies in one of many categories Copy Ask AI { "filter": { "$or": [\ {"categories": "Aerospace & Defense"},\ {"categories": "Biotechnology"}\ ] } } Select attributes can also be filtered based on when they were modified, using the `active_from` property. This allows automations based on when the attribute was changed. This filter supports the `$lt`, `$lte`, `$gt`, `$gte` operators: Finding companies where the category was changed this week ... where the category was not changed this year Copy Ask AI { "filter": { "categories": { "active_from": { "$gte": "2023-11-20" } } } } Was this page helpful? YesNo [Record reference](https://docs.attio.com/docs/attribute-types/attribute-types-record-reference) [Status](https://docs.attio.com/docs/attribute-types/attribute-types-status) ⌘I --- # List attributes - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes List attributes [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List attributes cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"\ },\ "title": "Rating",\ "description": "Rating of the record out of 5",\ "api_slug": "Rating",\ "type": "rating",\ "is_system_attribute": false,\ "is_writable": true,\ "is_required": false,\ "is_unique": false,\ "is_multiselect": false,\ "is_default_value_enabled": false,\ "is_archived": false,\ "default_value": null,\ "relationship": null,\ "created_at": "2021-11-21T13:22:49.061Z",\ "config": {\ "currency": {\ "default_currency_code": null,\ "display_type": null\ },\ "record_reference": {\ "allowed_object_ids": null\ }\ }\ }\ ] } GET / v2 / {target} / {identifier} / attributes Try it List attributes cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/{target}/{identifier}/attributes \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"\ },\ "title": "Rating",\ "description": "Rating of the record out of 5",\ "api_slug": "Rating",\ "type": "rating",\ "is_system_attribute": false,\ "is_writable": true,\ "is_required": false,\ "is_unique": false,\ "is_multiselect": false,\ "is_default_value_enabled": false,\ "is_archived": false,\ "default_value": null,\ "relationship": null,\ "created_at": "2021-11-21T13:22:49.061Z",\ "config": {\ "currency": {\ "default_currency_code": null,\ "display_type": null\ },\ "record_reference": {\ "allowed_object_ids": null\ }\ }\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#parameter-target) target enum required Whether the attributes are on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#parameter-identifier) identifier string required A UUID or slug to identify the object or list the attributes belong to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#parameter-limit) limit integer The maximum number of results to return. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `10` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#parameter-offset) offset integer The number of results to skip over before returning. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `5` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#parameter-show-archived) show\_archived boolean Whether archived attributes should be included in the results. See the [full guide to archiving here](https://docs.attio.com/docs/archiving-vs-deleting) . Example: `true` #### Response 200 - application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-attributes#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [Update an object](https://docs.attio.com/rest-api/endpoint-reference/objects/update-an-object) [Create an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/create-an-attribute) ⌘I --- # List deal record entries - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Deals List deal record entries [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List deal record entries cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/deals/records/{record_id}/entries \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",\ "list_api_slug": "hiring-engineering",\ "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",\ "created_at": "2022-11-21T13:22:49.061281000Z"\ }\ ] } GET / v2 / objects / deals / records / {record\_id} / entries Try it List deal record entries cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/deals/records/{record_id}/entries \ --header 'Authorization: Bearer ' 200 Copy Ask AI { "data": [\ {\ "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0",\ "list_api_slug": "hiring-engineering",\ "entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",\ "created_at": "2022-11-21T13:22:49.061281000Z"\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#parameter-record-id) record\_id string required A UUID of the deal record to fetch entries for. Example: `"1eec4535-30a1-4bc0-be24-e255d3fb5ac5"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#parameter-limit) limit integer The maximum number of results to return. The default is `100` and the maximum is `1000`. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `10` [​](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#parameter-offset) offset integer The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `5` #### Response 200 - application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-entries#response-data) data object\[\] required Show child attributes Was this page helpful? YesNo [List deal record attribute values](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-record-attribute-values) [List deal records](https://docs.attio.com/rest-api/endpoint-reference/deals/list-deal-records) ⌘I --- # Get a deal record - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Deals Get a deal record [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Get a deal record cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/deals/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } GET / v2 / objects / deals / records / {record\_id} Try it Get a deal record cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/deals/records/{record_id} \ --header 'Authorization: Bearer ' 200 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record#parameter-record-id) record\_id string required A UUID of the deal record to fetch. Example: `"1eec4535-30a1-4bc0-be24-e255d3fb5ac5"` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record#response-data) data object required Show child attributes Was this page helpful? YesNo [Create a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record) [Delete a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/delete-a-deal-record) ⌘I --- # List company record attribute values - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Companies List company record attribute values [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) List company record attribute values cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/companies/records/{record_id}/attributes/{attribute}/values \ --header 'Authorization: Bearer ' 200 400 404 Copy Ask AI { "data": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "workspace-member",\ "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"\ },\ "domain": "attio.com",\ "root_domain": "attio.com",\ "attribute_type": "domain"\ }\ ] } GET / v2 / objects / companies / records / {record\_id} / attributes / {attribute} / values Try it List company record attribute values cURL Copy Ask AI curl --request GET \ --url https://api.attio.com/v2/objects/companies/records/{record_id}/attributes/{attribute}/values \ --header 'Authorization: Bearer ' 200 400 404 Copy Ask AI { "data": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "workspace-member",\ "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"\ },\ "domain": "attio.com",\ "root_domain": "attio.com",\ "attribute_type": "domain"\ }\ ] } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#parameter-record-id) record\_id string required A UUID of the company record to fetch attribute values for. Example: `"99a03ff3-0435-47da-95cc-76b2caeb4dab"` [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#parameter-attribute) attribute string required A UUID or slug to identify the attribute you want to query values on. Example: `"domains"` #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#parameter-show-historic) show\_historic boolean default:false If `true`, the endpoint will return all historic values for the attribute. If `false`, the endpoint will only return the currently active value(s). Defaults to `false`. Cannot be set to `true` for COMINT attributes or enriched attributes on people/company objects. Example: `true` [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#parameter-limit) limit integer The maximum number of results to return. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `10` [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#parameter-offset) offset integer The number of results to skip over before returning. See the [full guide to pagination here](https://docs.attio.com/rest-api/guides/pagination) . Example: `5` #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-attribute-values#response-data) data object\[\] required * Option 1 * Option 2 * Option 3 * Option 4 * Option 5 * Option 6 * Option 7 * Option 8 * Option 9 * Option 10 * Option 11 * Option 12 * Option 13 * Option 14 * Option 15 * Option 16 * Option 17 Show child attributes Was this page helpful? YesNo [Update a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/update-a-company-record) [List company record entries](https://docs.attio.com/rest-api/endpoint-reference/companies/list-company-record-entries) ⌘I --- # Update an attribute - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Attributes Update an attribute [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Update an attribute cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Your Attribute", "description": "Lorem ipsum", "api_slug": "my-attribute", "is_required": true, "is_unique": true, "default_value": { "type": "static", "template": [\ {\ "value": 5\ }\ ] }, "config": { "currency": { "default_currency_code": "USD", "display_type": "symbol" }, "record_reference": { "allowed_objects": [\ "people"\ ] } }, "is_archived": false } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } PATCH / v2 / {target} / {identifier} / attributes / {attribute} Try it Update an attribute cURL Copy Ask AI curl --request PATCH \ --url https://api.attio.com/v2/{target}/{identifier}/attributes/{attribute} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "title": "Your Attribute", "description": "Lorem ipsum", "api_slug": "my-attribute", "is_required": true, "is_unique": true, "default_value": { "type": "static", "template": [\ {\ "value": 5\ }\ ] }, "config": { "currency": { "default_currency_code": "USD", "display_type": "symbol" }, "record_reference": { "allowed_objects": [\ "people"\ ] } }, "is_archived": false } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Path Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#parameter-target) target enum required Whether the attribute is on an object or a list. Available options: `objects`, `lists` Example: `"lists"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#parameter-identifier) identifier string required A UUID or slug to identify the object or list the attribute belongs to. Example: `"33ebdbe9-e529-47c9-b894-0ba25e9c15c0"` [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#parameter-attribute) attribute string required A UUID or slug to identify the attribute. Example: `"41252299-f8c7-4b5e-99c9-4ff8321d2f96"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/attributes/update-an-attribute#response-data) data object required Show child attributes Example: { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "title": "Rating", "description": "Rating of the record out of 5", "api_slug": "Rating", "type": "rating", "is_system_attribute": false, "is_writable": true, "is_required": false, "is_unique": false, "is_multiselect": false, "is_default_value_enabled": false, "is_archived": false, "default_value": null, "relationship": null, "created_at": "2021-11-21T13:22:49.061Z", "config": { "currency": { "default_currency_code": null, "display_type": null }, "record_reference": { "allowed_object_ids": null } }} Was this page helpful? YesNo [Get an attribute](https://docs.attio.com/rest-api/endpoint-reference/attributes/get-an-attribute) [List select options](https://docs.attio.com/rest-api/endpoint-reference/attributes/list-select-options) ⌘I --- # Assert a deal record - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Deals Assert a deal record [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Assert a deal record cURL Copy Ask AI curl --request PUT \ --url https://api.attio.com/v2/objects/deals/records \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "values": { "name": "Contract with Fundstack", "stage": "In Progress", "owner": "person@company.com", "value": 4200, "associated_people": [\ {\ "target_object": "people",\ "email_addresses": [\ {\ "email_address": "person@company.com"\ }\ ]\ }\ ], "associated_company": { "target_object": "companies", "domains": [\ {\ "domain": "company.com"\ }\ ] } } } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } PUT / v2 / objects / deals / records Try it Assert a deal record cURL Copy Ask AI curl --request PUT \ --url https://api.attio.com/v2/objects/deals/records \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "values": { "name": "Contract with Fundstack", "stage": "In Progress", "owner": "person@company.com", "value": 4200, "associated_people": [\ {\ "target_object": "people",\ "email_addresses": [\ {\ "email_address": "person@company.com"\ }\ ]\ }\ ], "associated_company": { "target_object": "companies", "domains": [\ {\ "domain": "company.com"\ }\ ] } } } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Query Parameters [​](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#parameter-matching-attribute) matching\_attribute string required The ID or slug of the attribute to use to check if a deal already exists. The attribute must be unique. There is no unique attribute on deals by default, so you should add your own. Example: `"custom_deal_attribute"` #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#response-data) data object required Show child attributes Was this page helpful? YesNo [List user record entries](https://docs.attio.com/rest-api/endpoint-reference/users/list-user-record-entries) [Create a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record) ⌘I --- # Create a deal record - Attio Docs [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Deals Create a deal record [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) Create a deal record cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/objects/deals/records \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "values": { "name": "Contract with Fundstack", "stage": "In Progress", "owner": "person@company.com", "value": 4200, "associated_people": [\ {\ "target_object": "people",\ "email_addresses": [\ {\ "email_address": "person@company.com"\ }\ ]\ }\ ], "associated_company": { "target_object": "companies", "domains": [\ {\ "domain": "company.com"\ }\ ] } } } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } POST / v2 / objects / deals / records Try it Create a deal record cURL Copy Ask AI curl --request POST \ --url https://api.attio.com/v2/objects/deals/records \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "data": { "values": { "name": "Contract with Fundstack", "stage": "In Progress", "owner": "person@company.com", "value": 4200, "associated_people": [\ {\ "target_object": "people",\ "email_addresses": [\ {\ "email_address": "person@company.com"\ }\ ]\ }\ ], "associated_company": { "target_object": "companies", "domains": [\ {\ "domain": "company.com"\ }\ ] } } } }' 200 400 404 Copy Ask AI { "data": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795", "record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "created_at": "2022-11-21T13:22:49.061281000Z", "web_url": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b", "values": { "name": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "value": "Contract with Fundstack",\ "attribute_type": "text"\ }\ ], "stage": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "status": {\ "title": "In Progress",\ "id": {\ "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",\ "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",\ "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96",\ "status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee"\ },\ "is_archived": false,\ "celebration_enabled": false,\ "target_time_in_status": null\ },\ "attribute_type": "status"\ }\ ], "owner": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "referenced_actor_type": "workspace-member",\ "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",\ "attribute_type": "actor-reference"\ }\ ], "value": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "currency_value": 4200,\ "currency_code": "USD",\ "attribute_type": "currency"\ }\ ], "associated_people": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "people",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ], "associated_company": [\ {\ "active_from": "2023-01-01T15:00:00.000000000Z",\ "active_until": null,\ "created_by_actor": {\ "type": "system",\ "id": null\ },\ "target_object": "companies",\ "target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",\ "attribute_type": "record-reference"\ }\ ] } } } #### Authorizations [​](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record#authorization-authorization) Authorization string header required This API uses OAuth 2.0 with the authorization code grant flow. #### Body application/json [​](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record#body-data) data object required Show child attributes #### Response 200 application/json Success [​](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record#response-data) data object required Show child attributes Was this page helpful? YesNo [Assert a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record) [Get a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/get-a-deal-record) ⌘I --- # Page Not Found [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/oauth-20/authorize-endpoint#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Page Not Found [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Connect an app to Attio through OAuth](https://docs.attio.com/rest-api/tutorials/connect-an-app-through-oauth#) [Authenticating requests](https://docs.attio.com/rest-api/guides/authentication#authenticating-requests) [Overview](https://docs.attio.com/rest-api/overview#) ⌘I --- # Page Not Found [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/standard-objects/companies/assert-a-company-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Page Not Found [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Update a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/update-a-company-record#) [Assert a record](https://docs.attio.com/rest-api/endpoint-reference/records/assert-a-record#) [Assert a company record](https://docs.attio.com/rest-api/endpoint-reference/companies/assert-a-company-record#) ⌘I --- # Page Not Found [Skip to main content](https://docs.attio.com/rest-api/endpoint-reference/standard-objects/deals/assert-a-deal-record#content-area) [Attio Docs home page![light logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/light.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=8c310b052d8cd8da48a6fc58ebeeba72)![dark logo](https://mintcdn.com/attio/2EyaTyByKNPeSVcd/logo/dark.svg?fit=max&auto=format&n=2EyaTyByKNPeSVcd&q=85&s=34020b723ed3cfc861b2c0c9d8c78610)](https://docs.attio.com/) Search... ⌘K Search... Navigation Page Not Found [Overview](https://docs.attio.com/docs/overview) [App SDK](https://docs.attio.com/sdk/guides/creating-an-app) [REST API](https://docs.attio.com/rest-api/overview) 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Update a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/update-a-deal-record#) [Assert a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/assert-a-deal-record#) [Create a deal record](https://docs.attio.com/rest-api/endpoint-reference/deals/create-a-deal-record#) ⌘I ---