{ "openapi": "3.1.0", "info": { "title": "Attio API", "version": "2.0.0", "contact": { "name": "Attio Support", "email": "support@attio.com", "url": "https://attio.com/help" } }, "tags": [{ "name": "Objects", "description": "Objects are the core data models inside of Attio. They contain standard objects, such as [people](/rest-api/endpoint-reference/standard-objects/people/list-person-records), [companies](/rest-api/endpoint-reference/standard-objects/companies/list-company-records) or [deals](/docs/standard-objects-deals), and custom objects that are specific to your use-case. See our [objects and lists guide](/docs/objects-and-lists) for more information." }, { "name": "Attributes", "description": "Attributes model properties of objects and lists. Some attributes, such as the `name` attribute on a person, are system-defined, while others are user-defined. Attributes are one of [many types](/docs/attribute-types) such as text, location or select. See our [objects and lists guide](/docs/objects-and-lists) for more information." }, { "name": "Records", "description": "Records are individual instances of objects e.g. a specific [person](/rest-api/endpoint-reference/standard-objects/people/list-person-records) or [company](/rest-api/endpoint-reference/standard-objects/companies/list-company-records). See our [objects and lists guide](/docs/objects-and-lists) for more information." }, { "name": "Lists", "description": "Lists are used to model a particular process. A list contains many records of a single object type, where each record is represented by an entry. Entries contain their own data from attributes defined on the list and also data from their parent record. See our [objects and lists guide](/docs/objects-and-lists) for more information." }, { "name": "Meta", "description": "Meta endpoints are used to get information about the API token." }, { "name": "Entries", "description": "Entries are elements in a list that reference a single parent record. Entries contain their own data from attributes defined on the list and also data from their parent record. See our [objects and lists guide](/docs/objects-and-lists) for more information." }, { "name": "Workspace members", "description": "Workspace members represent a user with access to a workspace. Workspace members are assigned roles that determine what they can do within the workspace." }, { "name": "Notes", "description": "Notes are rich text documents that reference a single parent record." }, { "name": "Meetings", "description": "Meetings are events synced from your calendar, added manually or added from third-party integrations." }, { "name": "Call recordings", "description": "Call recordings store video, audio, transcript and speaker information for calls. They are linked to meetings." }, { "name": "Tasks", "description": "A task is a defined, actionable item with references to linked records and assigned workspace members." }, { "name": "Webhooks", "description": "Webhooks allow you to listen for changes to data in Attio, for example when a record is updated." }, { "name": "Threads", "description": "Threads are groups of [comments](/rest-api/endpoint-reference/comments/get-a-comment) on either a record or entry." }, { "name": "Comments", "description": "Comments are messages on a [thread](/rest-api/endpoint-reference/threads/list-threads)." }, { "name": "People", "description": "People are one of the core objects inside of Attio. Person records can be added to lists and can be created automatically when syncing your mailbox." }, { "name": "Companies", "description": "Companies are one of the core objects inside of Attio. Company records can be added to lists and can be created automatically when syncing your mailbox." }, { "name": "Users", "description": "Users are an optional standard object that represents a user of your system. Users can belong to many workspaces." }, { "name": "Deals", "description": "Deals are an optional standard object that represent a deal or opportunity." }, { "name": "Workspaces", "description": "Workspaces are an optional standard object that represent a workspace or account in your system. Workspaces have many users and can be used to model a multi-tenant system. A company record can optionally have multiple workspaces." }], "security": [{ "oauth2": [] }], "servers": [{ "url": "https://api.attio.com", "description": "Production" }], "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "description": "This API uses OAuth 2.0 with the authorization code grant flow.", "flows": { "authorizationCode": { "authorizationUrl": "https://app.attio.com/authorize", "tokenUrl": "https://app.attio.com/oauth/token", "scopes": { "user_management:read": "View workspace members.", "user_management:read-write": "View workspace members.", "record_permission:read": "View, and optionally write, records.", "record_permission:read-write": "View, and optionally write, records.", "object_configuration:read": "View, and optionally write, the configuration and attributes of objects.", "object_configuration:read-write": "View, and optionally write, the configuration and attributes of objects.", "list_entry:read": "View, and optionally write, the entries in a list.", "list_entry:read-write": "View, and optionally write, the entries in a list.", "list_configuration:read": "View, and optionally write, the configuration and attributes of lists.", "list_configuration:read-write": "View, and optionally write, the configuration and attributes of lists.", "public_collection:read": "View, and optionally write, both the settings and information within public collections.", "public_collection:read-write": "View, and optionally write, both the settings and information within public collections.", "private_collection:read": "View, and optionally modify, both the settings and information of all collections within the workspace, regardless of their access settings.", "private_collection:read-write": "View, and optionally modify, both the settings and information of all collections within the workspace, regardless of their access settings.", "comment:read": "View comments (and threads), and optionally write comments.", "comment:read-write": "View comments (and threads), and optionally write comments.", "task:read": "View, and optionally write, tasks.", "task:read-write": "View, and optionally write, tasks.", "note:read": "View, and optionally write, notes.", "note:read-write": "View, and optionally write, notes.", "meeting:read": "View, and optionally write, meetings.", "meeting:read-write": "View, and optionally write, meetings.", "call_recording:read": "View, and optionally write, call recordings, transcripts and speakers for meetings.", "call_recording:read-write": "View, and optionally write, call recordings, transcripts and speakers for meetings.", "webhook:read": "View, and optionally manage, webhooks.", "webhook:read-write": "View, and optionally manage, webhooks." } } } } }, "schemas": { "status": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "The ID of the object", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "attribute_id": { "type": "string", "format": "uuid", "description": "The ID of the attribute", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "status_id": { "type": "string", "format": "uuid", "description": "The ID of the status", "example": "11f07f01-c10f-4e05-a522-33e050bc52ee" } }, "required": ["workspace_id", "object_id", "attribute_id", "status_id"] }, "title": { "type": "string", "description": "The title of the status", "example": "In Progress" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the status. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": false }, "celebration_enabled": { "type": "boolean", "description": "Whether arriving at this status triggers a celebration effect in the UI", "example": false }, "target_time_in_status": { "type": ["string", "null"], "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string", "example": "P0Y0M1DT0H0M0S" } }, "required": ["id", "title", "is_archived", "celebration_enabled", "target_time_in_status"] }, "select-option": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "The ID of the object", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "attribute_id": { "type": "string", "format": "uuid", "description": "The ID of the attribute", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "option_id": { "type": "string", "format": "uuid", "description": "The ID of the select option", "example": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" } }, "required": ["workspace_id", "object_id", "attribute_id", "option_id"] }, "title": { "type": "string", "description": "The title of the select option", "example": "Medium" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the select option. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": false } }, "required": ["id", "title", "is_archived"] }, "input-value": { "anyOf": [{ "type": "object", "properties": { "referenced_actor_type": { "type": "string", "enum": ["workspace-member"], "description": "The type of the referenced actor. Currently, only workspace members can be written into actor reference attributes. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": "string", "format": "uuid", "description": "The ID of the referenced Actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["referenced_actor_type", "referenced_actor_id"], "additionalProperties": false }, { "type": "object", "properties": { "workspace_member_email_address": { "type": "string", "description": "Workspace member actors can be referenced by email address as well as actor ID.", "example": "alice@attio.com" } }, "required": ["workspace_member_email_address"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true } }, "required": ["value"], "additionalProperties": false }, { "type": "object", "properties": { "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 } }, "required": ["currency_value"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["value"], "additionalProperties": false }, { "type": "object", "properties": { "domain": { "type": "string", "description": "The full domain of the website.", "example": "app.attio.com" } } }, { "type": "object", "properties": { "email_address": { "type": "string", "description": "An email address string", "example": "alice@app.attio.com" } } }, { "type": "object", "properties": { "target_object": { "type": "string", "description": "A UUID or slug to identify the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } }, "required": ["target_object", "target_record_id"], "additionalProperties": false }, { "type": "object", "example": { "target_object": "people", "matching_attribute_id_123": [{ "value": "matching_attribute_id_123" }] }, "properties": { "target_object": { "type": "string", "example": "people", "description": "A UUID or slug to identify the object that the referenced record belongs to." }, "[slug_or_id_of_matching_attribute]": { "type": "array", "description": "In addition to referencing records directly by record ID, you may also reference by a matching attribute of your choice. For example, if you want to add a reference to the person record with email \"alice@website.com\", you should pass a value with `target_object` set to `\"people\"` and `email_addresses` set to `[{email_address:\"alice@website.com\"}]`. The key should be the slug or ID of the matching attribute you would like to use and the value should be an array containing a single value of the appropriate attribute type (as specified below). Matching on multiple values is not currently supported. Matching attributes must be unique. This process is similar to how you use the `matching_attribute` query param in Attio's [assert endpoints](/rest-api/endpoint-reference/records/assert-a-record).", "items": { "anyOf": [{ "type": "object", "properties": { "domain": { "type": "string", "example": "app.attio.com", "description": "The full domain of the website." } } }, { "type": "object", "properties": { "email_address": { "type": "string", "example": "alice@app.attio.com", "description": "An email address string" } } }, { "type": "object", "properties": { "value": { "type": "number", "example": 17224912, "description": "Numbers are persisted as 64 bit floats." } } }, { "type": "object", "properties": { "original_phone_number": { "type": "string", "example": "07234172834", "description": "The raw, original phone number, as inputted." }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "GB", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to." } } }, { "type": "object", "properties": { "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB." } } }] } } }, "required": ["target_object", "[slug_or_id_of_matching_attribute]"] }, { "type": "object", "properties": { "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } }, "required": ["interaction_type", "interacted_at", "owner_actor"], "additionalProperties": false }, { "type": "object", "properties": { "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" } }, "required": ["line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 } }, "required": ["value"], "additionalProperties": false }, { "type": "object", "properties": { "first_name": { "type": "string", "example": "Ada", "description": "The first name." }, "last_name": { "type": "string", "example": "Lovelace", "description": "The last name." }, "full_name": { "type": "string", "example": "Ada Lovelace", "description": "The full name." } } }, { "type": "object", "required": ["original_phone_number"], "properties": { "original_phone_number": { "type": "string", "example": "+15558675309", "description": "A phone number which is either a) prefixed with a country code (e.g. `+44....`) or b) a local number, where `country_code` is specified in addition." }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "GB", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to. Optional if `original_phone_number` includes a country code prefix." } } }, { "type": "object", "properties": { "status": { "type": "string", "minLength": 1, "description": "The UUID or status title identifying the selected status.", "example": "In Progress" } }, "required": ["status"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 } }, "required": ["value"], "additionalProperties": false }, { "type": "object", "properties": { "option": { "type": "string", "minLength": 1, "description": "The UUID or select option title identifying the selected select option.", "example": "Medium" } }, "required": ["option"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." } }, "required": ["value"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["value"], "additionalProperties": false }], "description": "A union of possible value types, as required in request bodies." }, "output-value": { "anyOf": [{ "type": "object", "properties": { "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["value", "attribute_type"] }, { "type": "object", "properties": { "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "status": { "type": "string", "format": "uuid", "description": "The UUID identifying the selected status.", "example": "11f07f01-c10f-4e05-a522-33e050bc52ee" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "option": { "type": "string", "format": "uuid", "description": "The UUID identifying the selected select option.", "example": "08c2c59a-c18e-40c6-8dc4-95415313b2ea" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["attribute_type", "value"], "additionalProperties": false }], "description": "A union of possible value types, as returned in response bodies." }, "attribute": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID representing the workspace this attribute belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the object or list that this attribute belongs to", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "attribute_id": { "type": "string", "format": "uuid", "description": "A UUID to identify this attribute.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" } }, "required": ["workspace_id", "object_id", "attribute_id"] }, "title": { "type": "string", "description": "A title for the attribute, to be displayed across the app.", "example": "Rating" }, "description": { "type": ["string", "null"], "description": "A text description of the attribute.", "example": "A rating attribute" }, "api_slug": { "type": "string", "description": "A unique slug for the attribute for use in API responses and URLs. Formatted in snake case.", "example": "my-rating" }, "type": { "type": "string", "enum": ["text", "number", "checkbox", "currency", "date", "timestamp", "rating", "status", "select", "record-reference", "actor-reference", "location", "domain", "email-address", "phone-number", "interaction", "personal-name"], "description": "The type of the attribute.", "example": "text" }, "is_system_attribute": { "type": "boolean", "description": "`true` if this is an Attio system-defined attribute, `false` if defined by a user or non-Attio system.", "example": true }, "is_writable": { "type": "boolean", "description": "Whether or not this attribute can be written to. Can only be false when `is_system_attribute` is `true` (user-defined attributes are always writeable). If `false`, this usually means the attribute is enriched by Attio.", "example": true }, "is_required": { "type": "boolean", "description": "When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`.", "example": true }, "is_unique": { "type": "boolean", "description": "Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.", "example": true }, "is_multiselect": { "type": "boolean", "description": "Whether or not this attribute can have multiple values. Multiselect is only available on some value types.", "example": true }, "is_default_value_enabled": { "type": "boolean", "description": "Whether this attribute has a default value enabled. Must be `true` when `is_required` is `true`.", "example": true }, "is_archived": { "type": "boolean", "description": "Whether this attribute has been archived. Archived attributes are hidden from most UI, but can be restored either over the API or in workspace settings. See the [guide on archiving and deleting](/docs/archiving-vs-deleting)for more information.", "example": false }, "default_value": { "anyOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["dynamic"], "example": "dynamic" }, "template": { "anyOf": [{ "type": "string", "enum": ["current-user"], "description": "For actor reference attributes, you may pass a dynamic value of `\"current-user\"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.", "example": "current-user" }, { "type": "string", "description": "Timestamp attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }, { "type": "string", "description": "Date attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }] } }, "required": ["type", "template"] }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["static"], "example": "static" }, "template": { "type": "array", "items": { "$ref": "#/components/schemas/output-value" }, "example": [{ "value": "Some default text", "attribute_type": "text" }] } }, "required": ["type", "template"] }, { "type": "null" }], "description": "The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute." }, "relationship": { "type": ["object", "null"], "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID representing the workspace this attribute belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the object or list that this attribute belongs to", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "attribute_id": { "type": "string", "format": "uuid", "description": "A UUID to identify this attribute.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" } }, "required": ["workspace_id", "object_id", "attribute_id"] } }, "required": ["id"], "description": "If this attribute is related to another attribute, this is an object that includes an `id` property that identifies the other attribute. `null` means no relationship exists. See [the help center](https://attio.com/help/reference/managing-your-data/attributes#relationship-attributes) for more details about relationship attributes." }, "created_at": { "type": "string", "description": "When this attribute was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "config": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "default_currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 code representing the currency that values for this attribute should be stored in.", "example": "USD" }, "display_type": { "type": ["string", "null"], "enum": ["code", "name", "narrowSymbol", "symbol"], "description": "How the currency should be displayed across the app. \"code\" will display the ISO currency code e.g. \"USD\", \"name\" will display the localized currency name e.g. \"British pound\", \"narrowSymbol\" will display \"$1\" instead of \"US$1\" and \"symbol\" will display a localized currency symbol such as \"$\".", "example": "code" } }, "required": ["default_currency_code", "display_type"], "description": "Configuration available for attributes of type \"currency\"." }, "record_reference": { "type": "object", "properties": { "allowed_object_ids": { "type": ["array", "null"], "items": { "type": "string", "format": "uuid", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "description": "A list of UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types." } }, "required": ["allowed_object_ids"], "description": "Configuration available for attributes of type \"record-reference\"." } }, "required": ["currency", "record_reference"], "description": "Additional, type-dependent configuration for the attribute." } }, "required": ["id", "title", "description", "api_slug", "type", "is_system_attribute", "is_writable", "is_required", "is_unique", "is_multiselect", "is_default_value_enabled", "is_archived", "default_value", "relationship", "created_at", "config"], "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 } } } }, "list": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace this list belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID to identify this list.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" } }, "required": ["workspace_id", "list_id"] }, "api_slug": { "type": "string", "description": "A human-readable slug for use in URLs and responses.", "example": "hiring-engineering" }, "name": { "type": "string", "description": "The name of the list, as viewed in the UI.", "example": "Hiring Engineering" }, "parent_object": { "type": "array", "items": { "type": "string" }, "description": "A UUID or slug to identify the allowed object type for records added to this list. All new Lists are expected to have exactly one parent object. However, some legacy lists may have multiple allowed parents so the return type of this field is an array.", "example": ["people"] }, "workspace_access": { "type": ["string", "null"], "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access granted to all members of the workspace for this list. `null` values represent a private list that only grants access to specific workspace members via the `workspace_member_access` property.", "example": "read-and-write" }, "workspace_member_access": { "type": "array", "items": { "type": "object", "properties": { "workspace_member_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace member to grant access to.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "level": { "type": "string", "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access to the list.", "example": "read-and-write" } }, "required": ["workspace_member_id", "level"] }, "description": "The level of access granted to specific workspace members for this list. An empty array represents a list that has granted access to no workspace members." }, "created_by_actor": { "type": "object", "description": "The actor which created this list.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "When the list was created.", "example": "2022-11-21T13:22:49.061281000Z" } }, "required": ["id", "api_slug", "name", "parent_object", "workspace_access", "workspace_member_access", "created_by_actor", "created_at"] }, "object": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace this object belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the object.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" } }, "required": ["workspace_id", "object_id"] }, "api_slug": { "type": ["string", "null"], "description": "A unique, human-readable slug to access the object through URLs and API calls. Formatted in snake case.", "example": "people" }, "singular_noun": { "type": ["string", "null"], "description": "The singular form of the object's name.", "example": "Person" }, "plural_noun": { "type": ["string", "null"], "description": "The plural form of the object's name.", "example": "People" }, "created_at": { "type": "string", "description": "When the object was created.", "example": "2022-11-21T13:22:49.061281000Z" } }, "required": ["id", "api_slug", "singular_noun", "plural_noun", "created_at"] }, "workspace-member": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the workspace member belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "workspace_member_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace member.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["workspace_id", "workspace_member_id"] }, "first_name": { "type": "string", "description": "The first name of the user.", "example": "Susan" }, "last_name": { "type": "string", "description": "The last name of the user.", "example": "Kare" }, "avatar_url": { "type": ["string", "null"], "format": "uri", "description": "A URL to the user's avatar image.", "example": "https://lh3.googleusercontent.com/a/ABdFTp7z6OgAW9EqZx78wTqPfWClGCJCZXFjQfBG7rd9=s96-c" }, "email_address": { "type": "string", "format": "email", "description": "The user's email address.", "example": "susan.kare@apple.com" }, "created_at": { "type": "string", "description": "When the workspace member was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "access_level": { "type": "string", "enum": ["admin", "member", "suspended"], "description": "Whether the workspace member is suspended or not and what level of privileges they have inside the workspace. We do not delete workspace members so that you can successfully attribute past actions to suspended workspace members.", "example": "member" } }, "required": ["id", "first_name", "last_name", "avatar_url", "email_address", "created_at", "access_level"] }, "comment": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the comment belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "comment_id": { "type": "string", "format": "uuid", "description": "The ID of the comment.", "example": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" } }, "required": ["workspace_id", "comment_id"] }, "thread_id": { "type": "string", "format": "uuid", "description": "The ID of the thread the comment belongs to.", "example": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "content_plaintext": { "type": "string", "description": "A plaintext representation of the content of the comment. References to workspace members are cast into email addresses, all other stylistic elements are removed.", "example": "Let's go ahead and close this deal, alice@attio.com." }, "entry": { "type": ["object", "null"], "properties": { "entry_id": { "type": "string", "format": "uuid", "description": "The ID of the entry the comment belongs to.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "list_id": { "type": "string", "format": "uuid", "description": "The ID of the list the entry belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" } }, "required": ["entry_id", "list_id"], "description": "The entry the comment belongs to, `null` for comments on records." }, "record": { "type": "object", "properties": { "record_id": { "type": "string", "format": "uuid", "description": "The ID of the record the comment belongs to.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" }, "object_id": { "type": "string", "format": "uuid", "description": "The ID of the object the record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" } }, "required": ["record_id", "object_id"], "description": "The record the comment belongs to." }, "resolved_at": { "type": ["string", "null"], "description": "Whether the comment is resolved.", "example": "2023-01-01T15:00:00.000000000Z" }, "resolved_by": { "type": "object", "description": "The actor that resolved this comment.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "When the note was created.", "example": "2023-01-01T15:00:00.000000000Z" }, "author": { "type": "object", "description": "Who wrote this comment. Note that the API provides the ability for API tokens to write comments on behalf of other actors.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } } }, "required": ["id", "thread_id", "content_plaintext", "entry", "record", "resolved_at", "resolved_by", "created_at", "author"] }, "note": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the note belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "note_id": { "type": "string", "format": "uuid", "description": "The ID of the note.", "example": "ff3f3bd4-40f4-4f80-8187-cd02385af424" } }, "required": ["workspace_id", "note_id"] }, "parent_object": { "type": "string", "description": "The slug or ID of the parent object the note belongs to.", "example": "people" }, "parent_record_id": { "type": "string", "format": "uuid", "description": "The ID of the parent record the note belongs to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "title": { "type": "string", "description": "The note title. The title is plaintext only and has no formatting.", "example": "Initial Prospecting Call Summary" }, "content_plaintext": { "type": "string", "description": "The plaintext representation of the note content. The line feed character `\\n` represents new lines within the note content.", "example": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points" }, "content_markdown": { "type": "string", "description": "The markdown representation of the note content. Supports a subset of markdown features including:\n- Headings (levels 1-3 only with `#`, `##`, `###`)\n- Unordered lists (`-`, `*`, `+`)\n- Ordered lists (`1.`, `2.`, etc.)\n- Text styling: `**bold**`, `*italic*`, `~~strikethrough~~`, `==highlighted==`\n- Links: `[link text](https://example.com)`\n\nNote that note images are not returned as part of the markdown API representation.", "example": "# Introduction\nDate and time of the call\nParticipants\nPurpose of the call\n\n## Customer Background\n- Company overview (industry, size, location)\n- Key business challenges\n- Current software solutions (if any) and pain points" }, "tags": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["workspace-member"], "description": "The type of entity tagged in the note. Can be either 'workspace-member' or 'record'" }, "workspace_member_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace member that is tagged in the note.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["type", "workspace_member_id"] }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["record"], "description": "The type of entity tagged in the note. Can be either 'workspace-member' or 'record'" }, "object": { "type": "string", "description": "The slug or ID of the object that the tagged record belongs to.", "example": "people" }, "record_id": { "type": "string", "format": "uuid", "description": "The ID of the record that is tagged in the note.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } }, "required": ["type", "object", "record_id"] }] }, "description": "An array of records or workspace members that are @-tagged in the note content.", "example": [{ "type": "workspace-member", "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, { "type": "record", "object": "people", "record_id": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }] }, "created_by_actor": { "type": "object", "description": "The actor that created this note.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "When the note was created.", "example": "2022-11-21T13:22:49.061281000Z" } }, "required": ["id", "parent_object", "parent_record_id", "title", "content_plaintext", "content_markdown", "tags", "created_by_actor", "created_at"] }, "task": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the task belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "task_id": { "type": "string", "format": "uuid", "description": "The ID of the task.", "example": "649e34f4-c39a-4f4d-99ef-48a36bef8f04" } }, "required": ["workspace_id", "task_id"] }, "content_plaintext": { "type": "string", "description": "The plaintext representation of the task content. Inline linked records will appear as \"@record name\" and are returned in the `linked_records` property.", "example": "Follow up on current software solutions" }, "deadline_at": { "type": ["string", "null"], "description": "The deadline date of the task. Returned as an ISO 8601 timestamp.", "example": "2023-01-01" }, "is_completed": { "type": "boolean", "description": "Whether the task has been completed.", "example": false }, "linked_records": { "type": "array", "items": { "type": "object", "properties": { "target_object_id": { "type": "string", "description": "The ID of the parent object the task refers to. At present, only `people` and `companies` are supported.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "The ID of the parent record the task refers to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } }, "required": ["target_object_id", "target_record_id"] }, "description": "Records linked to the task. Creating record links within task content text is not possible via the API at present." }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace member actor assigned to this task.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["referenced_actor_type", "referenced_actor_id"] }, "description": "Workspace members assigned to this task." }, "created_by_actor": { "type": "object", "description": "The actor that created this task.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "When the task was created.", "example": "2022-11-21T13:22:49.061281000Z" } }, "required": ["id", "content_plaintext", "deadline_at", "is_completed", "linked_records", "assignees", "created_by_actor", "created_at"] }, "thread": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the thread belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "thread_id": { "type": "string", "format": "uuid", "description": "The ID of the thread.", "example": "a649e4d9-435c-43fb-83ba-847b4876f27a" } }, "required": ["workspace_id", "thread_id"] }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/comment" }, "minItems": 1, "description": "An array of comments in the thread, sorted by `created_at`." }, "created_at": { "type": "string", "description": "When the thread was created.", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["id", "comments", "created_at"] } }, "parameters": {} }, "paths": { "/v2/objects": { "get": { "summary": "List objects", "description": "Lists all system-defined and user-defined objects in your workspace.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Objects"], "security": [{ "oauth2": ["object_configuration:read"] }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/object" } } }, "required": ["data"], "description": "Success" } } } } } }, "post": { "summary": "Create an object", "description": "Creates a new custom object in your workspace.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Objects"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case.", "example": "people" }, "singular_noun": { "type": "string", "minLength": 1, "description": "The singular form of the object's name.", "example": "Person" }, "plural_noun": { "type": "string", "minLength": 1, "description": "The plural form of the object's name.", "example": "People" } }, "required": ["api_slug", "singular_noun", "plural_noun"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/object" } }, "required": ["data"], "description": "Success" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "Failed to create object. Please ensure your api_slug and names are unique." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/objects/{object}": { "get": { "summary": "Get an object", "description": "Gets a single object by its `object_id` or slug.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Objects"], "security": [{ "oauth2": ["object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the object.", "example": "people" }, "required": true, "name": "object", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/object" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update an object", "description": "Updates a single object. The object to be updated is identified by its `object_id`.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Objects"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the object.", "example": "people" }, "required": true, "name": "object", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case.", "example": "people" }, "singular_noun": { "type": "string", "minLength": 1, "description": "The singular form of the object's name.", "example": "Person" }, "plural_noun": { "type": "string", "minLength": 1, "description": "The plural form of the object's name.", "example": "People" } } } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/object" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "You passed an empty payload. Please ensure you are updating at least one property in your request." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "Failed to update object. Please ensure api_slug is unique." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/{target}/{identifier}/attributes": { "get": { "summary": "List attributes", "description": "Lists all attributes defined on a specific object or list. Attributes are returned in the order that they are sorted by in the UI.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attributes are on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the attributes belong to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "boolean", "description": "Whether archived attributes should be included in the results. See the [full guide to archiving here](/docs/archiving-vs-deleting).", "example": true }, "required": false, "name": "show_archived", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/attribute" } } }, "required": ["data"], "description": "Success" } } } } } }, "post": { "summary": "Create an attribute", "description": "Creates a new attribute on either an object or a list.\n\nTo create an attribute on an object, you must also have the `object_configuration:read-write` scope.\n\nTo create an attribute on a list, you must also have the `list_configuration:read-write` scope.", "tags": ["Attributes"], "security": [{ "oauth2": [] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is to be created on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "required": true, "name": "identifier", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the attribute. The title will be visible across Attio's UI.", "example": "Your Attribute" }, "description": { "type": ["string", "null"], "description": "A text description for the attribute.", "example": "Lorem ipsum" }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case.", "example": "my-attribute" }, "type": { "type": "string", "enum": ["text", "number", "checkbox", "currency", "date", "timestamp", "rating", "status", "select", "record-reference", "actor-reference", "location", "domain", "email-address", "phone-number"], "description": "The type of the attribute. This value affects the possible `config` values. Attributes of type \"status\" are not supported on objects.", "example": "text" }, "is_required": { "type": "boolean", "description": "When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`.", "example": true }, "is_unique": { "type": "boolean", "description": "Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.", "example": true }, "is_multiselect": { "type": "boolean", "description": "Whether or not this attribute can have multiple values. Multiselect is only available on some value types.", "example": true }, "default_value": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["dynamic"], "example": "dynamic" }, "template": { "anyOf": [{ "type": "string", "enum": ["current-user"], "description": "For actor reference attributes, you may pass a dynamic value of `\"current-user\"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.", "example": "current-user" }, { "type": "string", "description": "Timestamp attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }, { "type": "string", "description": "Date attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }] } }, "required": ["type", "template"] }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["static"], "example": "static" }, "template": { "type": "array", "items": { "$ref": "#/components/schemas/input-value" }, "example": [{ "value": 5 }] } }, "required": ["type", "template"] }, { "type": "null" }], "description": "The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects.", "example": { "type": "static", "template": [{ "value": 5 }] } }, "config": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "default_currency_code": { "type": "string", "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 code representing the currency that values for this attribute should be stored in.", "example": "USD" }, "display_type": { "type": "string", "enum": ["code", "name", "narrowSymbol", "symbol"], "description": "How the currency should be displayed across the app. \"code\" will display the ISO currency code e.g. \"USD\", \"name\" will display the localized currency name e.g. \"British pound\", \"narrowSymbol\" will display \"$1\" instead of \"US$1\" and \"symbol\" will display a localized currency symbol such as \"$\".", "example": "symbol" } }, "required": ["default_currency_code", "display_type"], "description": "Configuration available for attributes of type \"currency\"." }, "record_reference": { "type": "object", "properties": { "allowed_objects": { "type": "array", "items": { "type": "string", "example": "people" }, "minItems": 1, "description": "A list of slugs or UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types." } }, "required": ["allowed_objects"], "description": "Configuration available for attributes of type \"record-reference\"." } } } }, "required": ["title", "description", "api_slug", "type", "is_required", "is_unique", "is_multiselect", "config"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/attribute" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "Could not find an object with slug \"people\" for default value." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"33ebdbe9-e529-47c9-b894-0ba25e9c15c0\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "An attribute with the same API slug already exists on this list. Please choose a different API slug." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/{target}/{identifier}/attributes/{attribute}": { "get": { "summary": "Get an attribute", "description": "Gets information about a single attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/attribute" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update an attribute", "description": "Updates a single attribute on a given object or list.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the attribute. The title will be visible across Attio's UI.", "example": "Your Attribute" }, "description": { "type": ["string", "null"], "description": "A text description for the attribute.", "example": "Lorem ipsum" }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case.", "example": "my-attribute" }, "is_required": { "type": "boolean", "description": "When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`.", "example": true }, "is_unique": { "type": "boolean", "description": "Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.", "example": true }, "default_value": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["dynamic"], "example": "dynamic" }, "template": { "anyOf": [{ "type": "string", "enum": ["current-user"], "description": "For actor reference attributes, you may pass a dynamic value of `\"current-user\"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.", "example": "current-user" }, { "type": "string", "description": "Timestamp attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }, { "type": "string", "description": "Date attributes may use an ISO 8601 duration as a dynamic value. For example, `\"P1M\"` would set the value to the current time plus one month.", "example": "P1M" }] } }, "required": ["type", "template"] }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["static"], "example": "static" }, "template": { "type": "array", "items": { "$ref": "#/components/schemas/input-value" }, "example": [{ "value": 5 }] } }, "required": ["type", "template"] }, { "type": "null" }], "description": "The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects.", "example": { "type": "static", "template": [{ "value": 5 }] } }, "config": { "type": "object", "properties": { "currency": { "type": "object", "properties": { "default_currency_code": { "type": "string", "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 code representing the currency that values for this attribute should be stored in.", "example": "USD" }, "display_type": { "type": "string", "enum": ["code", "name", "narrowSymbol", "symbol"], "description": "How the currency should be displayed across the app. \"code\" will display the ISO currency code e.g. \"USD\", \"name\" will display the localized currency name e.g. \"British pound\", \"narrowSymbol\" will display \"$1\" instead of \"US$1\" and \"symbol\" will display a localized currency symbol such as \"$\".", "example": "symbol" } }, "required": ["default_currency_code", "display_type"], "description": "Configuration available for attributes of type \"currency\"." }, "record_reference": { "type": "object", "properties": { "allowed_objects": { "type": "array", "items": { "type": "string", "example": "people" }, "minItems": 1, "description": "A list of slugs or UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types." } }, "required": ["allowed_objects"], "description": "Configuration available for attributes of type \"record-reference\"." } }, "description": "Additional, type-dependent configuration for the attribute." }, "is_archived": { "type": "boolean", "description": "Whether the attribute has been archived or not. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": false } }, "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/attribute" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["system_edit_unauthorized"] }, "message": { "type": "string", "example": "Cannot update a System attribute." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/{target}/{identifier}/attributes/{attribute}/options": { "get": { "summary": "List select options", "description": "Lists all select options for a particular attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute you want to list select options on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "boolean", "description": "`true` if you want the results to include archived select options.", "example": true }, "required": false, "name": "show_archived", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/select-option" } } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "post": { "summary": "Create a select option", "description": "Adds a select option to a select attribute on an object or a list.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute to create a select option on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "The Title of the select option", "example": "Medium" } }, "required": ["title"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/select-option" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "This attribute is not a select attribute." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "There is already another select option with the title \"Medium\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/{target}/{identifier}/attributes/{attribute}/options/{option}": { "patch": { "summary": "Update a select option", "description": "Updates a select option on an attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "enum": ["objects", "lists"], "description": "Whether the attribute is on an object or a list.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the select attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the select attribute.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or select option title to identify the select option you would like to update.", "example": "Medium" }, "required": true, "name": "option", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "The Title of the select option", "example": "Medium" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the select option. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": false } } } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/select-option" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Cannot find select attribute with select option title \"Medium\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "There is already another select option with the title \"Medium\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/{target}/{identifier}/attributes/{attribute}/statuses": { "get": { "summary": "List statuses", "description": "Lists all statuses for a particular status attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "enum": ["lists", "objects"], "description": "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.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute you want to list statuses on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "boolean", "description": "`true` if you want the results to include archived statuses. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": true, "default": false }, "required": false, "name": "show_archived", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/status" } } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "post": { "summary": "Create a status", "description": "Add a new status to a status attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "enum": ["lists", "objects"], "description": "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.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute the status will belong to.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "The Title of the status", "example": "In Progress" }, "celebration_enabled": { "type": "boolean", "default": false, "description": "Whether arriving at this status triggers a celebration effect", "example": true }, "target_time_in_status": { "type": ["string", "null"], "pattern": "P(?:(\\d+Y)?(\\d+M)?(\\d+W)?(\\d+D)?(?:T(\\d+(?:[\\.,]\\d+)?H)?(\\d+(?:[\\.,]\\d+)?M)?(\\d+(?:[\\.,]\\d+)?S)?)?)", "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string", "example": "P0Y0M1DT0H0M0S" } }, "required": ["title"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/status" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "This attribute is not a status attribute." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "There is already another status with the title \"In Progress\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/{target}/{identifier}/attributes/{attribute}/statuses/{status}": { "patch": { "summary": "Update a status", "description": "Update a status on an status attribute on either an object or a list.\n\nRequired scopes: `object_configuration:read-write`.", "tags": ["Attributes"], "security": [{ "oauth2": ["object_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "enum": ["lists", "objects"], "description": "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.", "example": "lists" }, "required": true, "name": "target", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the object or list the status attribute belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "identifier", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute to update the status on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or status title to identify the status to update.", "example": "In Progress" }, "required": true, "name": "status", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "description": "The Title of the status", "example": "In Progress" }, "celebration_enabled": { "type": "boolean", "default": false, "description": "Whether arriving at this status triggers a celebration effect", "example": true }, "target_time_in_status": { "type": ["string", "null"], "pattern": "P(?:(\\d+Y)?(\\d+M)?(\\d+W)?(\\d+D)?(?:T(\\d+(?:[\\.,]\\d+)?H)?(\\d+(?:[\\.,]\\d+)?M)?(\\d+(?:[\\.,]\\d+)?S)?)?)", "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string", "example": "P0Y0M1DT0H0M0S" }, "is_archived": { "type": "boolean", "description": "Whether or not to archive the status. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving.", "example": false } } } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/status" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Cannot find status attribute with status option title \"Medium\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "There is already another status with the title \"In Progress\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/objects/{object}/records/query": { "post": { "summary": "List records", "description": "Lists people, company or other records, with the option to filter and sort results.\n\nRequired scopes: `record_permission:read`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the object to list records for.", "example": "people" }, "required": true, "name": "object", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "An object used to filter results to a subset of results. See the [full guide to filtering and sorting here](/rest-api/how-to/filtering-and-sorting).", "additionalProperties": true, "example": { "name": "Ada Lovelace" } }, "sorts": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "direction": { "type": "string", "enum": ["asc", "desc"], "description": "The direction to sort the results by." }, "attribute": { "type": "string", "description": "A slug or ID to identify the attribute to sort by." }, "field": { "type": "string", "description": "Which field on the value to sort by e.g. \"last_name\" on a name value." } }, "required": ["direction", "attribute"], "description": "Sort by attribute" }, { "type": "object", "properties": { "direction": { "type": "string", "enum": ["asc", "desc"], "description": "The direction to sort the results by." }, "path": { "type": "array", "items": { "type": "array", "items": { "anyOf": [{ "type": "string", "description": "The slug or ID of the object e.g. \"people\"." }, { "type": "string", "description": "A slug or ID to identify the attribute to sort by." }] }, "minItems": 2, "maxItems": 2 }, "description": "You may use the `path` property to traverse record reference attributes and parent records on list entries. `path` accepts an array of tuples where the first element of each tuple is the slug or ID of a list/object, and the second element is the slug or ID of an attribute on that list/object. The first element of the first tuple must correspond to the list or object that you are querying. For example, if you wanted to sort by the name of the parent record (a company) on a list with the slug \"sales\", you would pass the value `[['sales', 'parent_record'], ['companies', 'name']]`." }, "field": { "type": "string", "description": "Which field on the value to sort by e.g. \"last_name\" on a name value." } }, "required": ["direction", "path"], "description": "Sort by path" }] }, "description": "An object used to sort results. See the [full guide to filtering and sorting here](/rest-api/how-to/filtering-and-sorting).", "example": [{ "direction": "asc", "attribute": "name", "field": "last_name" }] }, "limit": { "type": "number", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 500 }, "offset": { "type": "number", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 0 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["filter_error"] }, "message": { "type": "string", "example": "Error in filter." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "The referenced object was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/objects/{object}/records": { "post": { "summary": "Create a record", "description": "Creates a new person, company or other record. This endpoint will throw on conflicts of unique attributes. If you would prefer to update records on conflicts, please use the [Assert record endpoint](/rest-api/endpoint-reference/records/assert-a-record) instead.\n\nRequired scopes: `record_permission:read-write`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read-write", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "The UUID or slug identifying the object the created record should belong to.", "example": "people" }, "required": true, "name": "object", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["values"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Cannot find select attribute with select option title \"In Progress\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "put": { "summary": "Assert a record", "description": "Use this endpoint to create or update people, companies and other records. A matching attribute is used to search for existing records. If a record is found with the same value for the matching attribute, that record will be updated. If no record with the same value for the matching attribute is found, a new record will be created instead. If you would like to avoid matching, please use the [Create record endpoint](/rest-api/endpoint-reference/records/create-a-record).\n\nIf the matching attribute is a multiselect attribute, new values will be added and existing values will not be deleted. For any other multiselect attribute, all values will be either created or deleted as necessary to match the list of supplied values.\n\nRequired scopes: `record_permission:read-write`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read-write", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the object the record should belong to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "description": "The ID or slug of the attribute to use to check if a record already exists. The attribute must be unique.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "matching_attribute", "in": "query" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["values"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "No attribute was found for matching_attribute slug/ID \"my-attribute\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/objects/{object}/records/{record_id}": { "get": { "summary": "Get a record", "description": "Gets a single person, company or other record by its `record_id`.\n\nRequired scopes: `record_permission:read`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug identifying the object that the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Record with ID \"891dcbfc-9141-415d-9b2a-2238a6cc012d\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update a record (append multiselect values)", "description": "Use this endpoint to update people, companies, and other records by `record_id`. If the update payload includes multiselect attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the `PUT` endpoint to overwrite or remove multiselect attribute values.\n\nRequired scopes: `record_permission:read-write`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read-write", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug of the object the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "description": "A UUID of the record to update.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["values"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["missing_value"] }, "message": { "type": "string", "example": "Required value for attribute with ID \"41252299-f8c7-4b5e-99c9-4ff8321d2f96\" was not provided." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "put": { "summary": "Update a record (overwrite multiselect values)", "description": "Use this endpoint to update people, companies, and other records by `record_id`. If the update payload includes multiselect attributes, the values supplied will overwrite/remove the list of values that already exist (if any). Use the `PATCH` endpoint to append multiselect values without removing those that already exist.\n\nRequired scopes: `record_permission:read-write`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read-write", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug of the object the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "description": "A UUID of the record to update.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["values"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this record belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "object_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the object this record belongs to.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["workspace_id", "object_id", "record_id"] }, "created_at": { "type": "string", "description": "When this record was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "web_url": { "type": "string", "format": "uri", "description": "A URL that links directly to the record page in the Attio web application.", "example": "https://app.attio.com/salarya/person/bf071e1f-6035-429d-b874-d83ea64ea13b" }, "values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A record type with an attribute `api_slug` as the key, and an array of value objects as the values." } }, "required": ["id", "created_at", "web_url", "values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["missing_value"] }, "message": { "type": "string", "example": "Required value for attribute with ID \"41252299-f8c7-4b5e-99c9-4ff8321d2f96\" was not provided." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a record", "description": "Deletes a single record (e.g. a company or person) by ID.\n\nRequired scopes: `object_configuration:read`, `record_permission:read-write`.", "tags": ["Records"], "security": [{ "oauth2": ["object_configuration:read", "record_permission:read-write"] }], "parameters": [{ "schema": { "type": "string", "description": "The UUID or slug of the object the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "description": "The UUID of the record to delete.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Record with ID \"891dcbfc-9141-415d-9b2a-2238a6cc012d\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/objects/{object}/records/{record_id}/attributes/{attribute}/values": { "get": { "summary": "List record attribute values", "description": "Gets all values for a given attribute on a record. Historic values can be queried using the `show_historic` query param. Historic values cannot be queried on COMINT (Communication Intelligence) or enriched attributes and the endpoint will return a 400 error if this is attempted. Historic values are sorted from oldest to newest (by `active_from`). Some attributes are subject to billing status and will return an empty array of values if theworkspace being queried does not have the required billing flag enabled.\n\nRequired scopes: `record_permission:read`, `object_configuration:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read", "object_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the object the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID to identify the record you want to query values on.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute you want to query values on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "boolean", "description": "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, "default": false }, "required": false, "name": "show_historic", "in": "query" }, { "schema": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "Cannot set show_historic param to true when querying a COMINT attribute." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Attribute with slug/ID \"my-attribute\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/objects/{object}/records/{record_id}/entries": { "get": { "summary": "List record entries", "description": "List all entries, across all lists, for which this record is the parent.\n\nRequired scopes: `record_permission:read`, `object_configuration:read`, `list_entry:read`.", "tags": ["Records"], "security": [{ "oauth2": ["record_permission:read", "object_configuration:read", "list_entry:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug identifying the object that the record belongs to.", "example": "people" }, "required": true, "name": "object", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": true, "name": "record_id", "in": "path" }, { "schema": { "type": "integer", "description": "The maximum number of results to return. The default is `100` and the maximum is `1000`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list that this record is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "list_api_slug": { "type": "string", "description": "A human-readable slug for the list for use in URLs and responses.", "example": "hiring-engineering" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry on the list.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" } }, "required": ["list_id", "list_api_slug", "entry_id", "created_at"] } } }, "required": ["data"], "description": "Success" } } } } } } }, "/v2/lists": { "get": { "summary": "List all lists", "description": "List all lists that your access token has access to. lists are returned in the order that they are sorted in the sidebar.\n\nRequired scopes: `list_configuration:read`.", "tags": ["Lists"], "security": [{ "oauth2": ["list_configuration:read"] }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/list" } } }, "required": ["data"], "description": "Success" } } } } } }, "post": { "summary": "Create a list", "description": "Creates a new list.\n\nOnce you have your list, add attributes to it using the [Create attribute](/rest-api/endpoint-reference/attributes/create-an-attribute) API, and add records to it using the [Add records to list](/rest-api/endpoint-reference/entries/create-an-entry-add-record-to-list) API. \n\nNew lists must specify which records can be added with the `parent_object` parameter which accepts either an object slug or an object ID. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters.\n\nPlease note that new lists must have either `workspace_access` set to `\"full-access\"` or one or more element of `workspace_member_access` with a `\"full-access\"` level. It is also possible to receive a `403` billing error if your workspace is not on a plan that supports either advanced workspace or workspace member-level access for lists.\n\nRequired scopes: `list_configuration:read-write`.", "tags": ["Lists"], "security": [{ "oauth2": ["list_configuration:read-write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable name of the list.", "example": "Enterprise Sales" }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the list through API calls. Should be formatted in snake case.", "example": "enterprise_sales" }, "parent_object": { "type": "string", "description": "A UUID or slug to identify the allowed object type for records added to this list.", "example": "people" }, "workspace_access": { "type": ["string", "null"], "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access granted to all members of the workspace for this list. Pass `null` to keep the list private and only grant access to specific workspace members.", "example": "read-and-write" }, "workspace_member_access": { "type": "array", "items": { "type": "object", "properties": { "workspace_member_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace member to grant access to.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "level": { "type": "string", "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access to the list.", "example": "read-and-write" } }, "required": ["workspace_member_id", "level"] }, "description": "The level of access granted to specific workspace members for this list. Pass an empty array to grant access to no workspace members." } }, "required": ["name", "api_slug", "parent_object", "workspace_access", "workspace_member_access"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/list" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Workspace member with ID \"50cf242c-7fa3-4cad-87d0-75b1af71c57b\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [403] }, "type": { "type": "string", "enum": ["auth_error"] }, "code": { "type": "string", "enum": ["billing_error"] }, "message": { "type": "string", "example": "You attempted to create a List using permissions features that are not currently supported on your plan. Please upgrade, contact sales, or try a different access configuration for your list." } }, "required": ["status_code", "type", "code", "message"], "description": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Parent object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [409] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["slug_conflict"] }, "message": { "type": "string", "example": "A list with api_slug \"my_list\" already exists." } }, "required": ["status_code", "type", "code", "message"], "description": "Conflict" } } } } } } }, "/v2/lists/{list}": { "get": { "summary": "Get a list", "description": "Gets a single list in your workspace that your access token has access to.\n\nRequired scopes: `list_configuration:read`.", "tags": ["Lists"], "security": [{ "oauth2": ["list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the list.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/list" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update a list", "description": "Updates an existing list. Permissions for the list are controlled with the `workspace_access` and `workspace_member_access` parameters. Please note that lists must have either `workspace_access` set to `\"full-access\"` or one or more element of `workspace_member_access` with a `\"full-access\"` level. It is also possible to receive a `403` billing error if your workspace is not on a plan that supports either advanced workspace or workspace member level access for lists. Changing the parent object of a list is not possible through the API as it can have unintended side-effects that should be considered carefully. If you wish to carry out a parent object change you should do so through the UI.\n\nRequired scopes: `list_configuration:read-write`.", "tags": ["Lists"], "security": [{ "oauth2": ["list_configuration:read-write"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the list to update.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "The human-readable name of the list.", "example": "Enterprise Sales" }, "api_slug": { "type": "string", "description": "A unique, human-readable slug to access the list through API calls. Should be formatted in snake case.", "example": "enterprise_sales" }, "workspace_access": { "type": ["string", "null"], "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access granted to all members of the workspace for this list. Pass `null` to keep the list private and only grant access to specific workspace members.", "example": "read-and-write" }, "workspace_member_access": { "type": "array", "items": { "type": "object", "properties": { "workspace_member_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace member to grant access to.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "level": { "type": "string", "enum": ["full-access", "read-and-write", "read-only"], "description": "The level of access to the list.", "example": "read-and-write" } }, "required": ["workspace_member_id", "level"] }, "description": "The level of access granted to specific workspace members for this list. Pass an empty array to grant access to no workspace members." } } } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/list" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Workspace member with ID \"50cf242c-7fa3-4cad-87d0-75b1af71c57b\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/lists/{list}/entries/query": { "post": { "summary": "List entries", "description": "Lists entries in a given list, with the option to filter and sort results.\n\nRequired scopes: `list_entry:read`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug to identify the list to retrieve entries from.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filter": { "type": "object", "description": "An object used to filter results to a subset of results. See the [full guide to filtering and sorting here](/rest-api/how-to/filtering-and-sorting).", "additionalProperties": true, "example": { "name": "Ada Lovelace" } }, "sorts": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "direction": { "type": "string", "enum": ["asc", "desc"], "description": "The direction to sort the results by." }, "attribute": { "type": "string", "description": "A slug or ID to identify the attribute to sort by." }, "field": { "type": "string", "description": "Which field on the value to sort by e.g. \"last_name\" on a name value." } }, "required": ["direction", "attribute"], "description": "Sort by attribute" }, { "type": "object", "properties": { "direction": { "type": "string", "enum": ["asc", "desc"], "description": "The direction to sort the results by." }, "path": { "type": "array", "items": { "type": "array", "items": { "anyOf": [{ "type": "string", "description": "The slug or ID of the object e.g. \"people\"." }, { "type": "string", "description": "A slug or ID to identify the attribute to sort by." }] }, "minItems": 2, "maxItems": 2 }, "description": "You may use the `path` property to traverse record reference attributes and parent records on list entries. `path` accepts an array of tuples where the first element of each tuple is the slug or ID of a list/object, and the second element is the slug or ID of an attribute on that list/object. The first element of the first tuple must correspond to the list or object that you are querying. For example, if you wanted to sort by the name of the parent record (a company) on a list with the slug \"sales\", you would pass the value `[['sales', 'parent_record'], ['companies', 'name']]`." }, "field": { "type": "string", "description": "Which field on the value to sort by e.g. \"last_name\" on a name value." } }, "required": ["direction", "path"], "description": "Sort by path" }] }, "description": "An object used to sort results. See the [full guide to filtering and sorting here](/rest-api/how-to/filtering-and-sorting).", "example": [{ "direction": "asc", "attribute": "name", "field": "last_name" }] }, "limit": { "type": "number", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 500 }, "offset": { "type": "number", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 0 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/lists/{list}/entries": { "post": { "summary": "Create an entry (add record to list)", "description": "Adds a record to a list as a new list entry. This endpoint will throw on conflicts of unique attributes. Multiple list entries are allowed for the same parent record\n\nRequired scopes: `list_entry:read-write`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read-write", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "The UUID or slug identifying the list that the created list entry should belong to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the added parent record belongs to.", "example": "people" }, "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["parent_record_id", "parent_object", "entry_values"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "Parent record with slug/ID \"891dcbfc-9141-415d-9b2a-2238a6cc012d\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Could not find list with slug/ID \"enterprise_sales\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "put": { "summary": "Assert a list entry by parent", "description": "Use this endpoint to create or update a list entry for a given parent record. If an entry with the specified parent record is found, that entry will be updated. If no such entry is found, a new entry will be created instead. If there are multiple entries with the same parent record, this endpoint with return the \"MULTIPLE_MATCH_RESULTS\" error. When writing to multi-select attributes, all values will be either created or deleted as necessary to match the list of values supplied in the request body.\n\nRequired scopes: `list_entry:read-write`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read-write", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record you want to add to the list. The record will become the 'parent' of the created list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the added parent record belongs to.", "example": "people" }, "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["parent_record_id", "parent_object", "entry_values"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["multiple_match_results"] }, "message": { "type": "string", "example": "Multiple entries were founds for the given parent record. Please remove duplicates or use the update or create entry endpoints instead." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"33ebdbe9-e529-47c9-b894-0ba25e9c15c0\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/lists/{list}/entries/{entry_id}": { "get": { "summary": "Get a list entry", "description": "Gets a single list entry by its `entry_id`.\n\nRequired scopes: `list_entry:read`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug identifying the list the entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": true, "name": "entry_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update a list entry (append multiselect values)", "description": "Use this endpoint to update list entries by `entry_id`. If the update payload includes multiselect attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the `PUT` endpoint to overwrite or remove multiselect attribute values.\n\nRequired scopes: `list_entry:read-write`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read-write", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }, { "schema": { "type": "string", "description": "A UUID of the list entry to update.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": true, "name": "entry_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["entry_values"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["immutable_value"] }, "message": { "type": "string", "example": "The parent record for a list entry cannot be updated once created." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "put": { "summary": "Update a list entry (overwrite multiselect values)", "description": "Use this endpoint to update list entries by `entry_id`. If the update payload includes multiselect attributes, the values supplied will overwrite/remove the list of values that already exist (if any). Use the `PATCH` endpoint to add multiselect attribute values without removing those value that already exist.\n\nRequired scopes: `list_entry:read-write`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read-write", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug of the list the list entry belongs to.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": true, "name": "list", "in": "path" }, { "schema": { "type": "string", "description": "A UUID of the list entry to update.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": true, "name": "entry_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entry_values": { "type": "object", "description": "An object with an attribute `api_slug` or `attribute_id` as the key, and a single value (for single-select attributes), or an array of values (for single or multi-select attributes) as the values. For complete documentation on values for all attribute types, please see our [attribute type docs](/docs/attribute-types).", "additionalProperties": { "type": "array" }, "example": { "41252299-f8c7-4b5e-99c9-4ff8321d2f96": "Text value", "multiselect_attribute": ["Select option 1", "Select option 2"] } } }, "required": ["entry_values"], "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the workspace this entry belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "list_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the list this entry is in.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "format": "uuid", "description": "A UUID identifying this entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["workspace_id", "list_id", "entry_id"] }, "parent_record_id": { "type": "string", "format": "uuid", "description": "A UUID identifying the record that is parent of the list entry.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "parent_object": { "type": "string", "description": "A UUID or slug identifying the object that the parent record belongs to.", "example": "people" }, "created_at": { "type": "string", "description": "When this entry was created.", "example": "2022-11-21T13:22:49.061281000Z" }, "entry_values": { "type": "object", "additionalProperties": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } }, "description": "A list of attribute values for the list entry (not attribute values for its parent record).", "example": { "status": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "status": { "id": { "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c", "object_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0", "attribute_id": "e350362f-4b55-4c0f-93f4-379ae8ff2e5b", "status_id": "527def35-7994-4ef7-9584-80ef8de352a8" }, "title": "In Progress", "is_archived": false, "target_time_in_status": null, "celebration_enabled": false }, "attribute_type": "status" }], "created_at": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "value": "2023-01-01T15:00:00.000000000Z", "attribute_type": "timestamp" }], "created_by": [{ "active_from": "2023-01-01T15:00:00.000000000Z", "active_until": null, "created_by_actor": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b", "referenced_actor_type": "workspace-member", "attribute_type": "actor-reference" }] } } }, "required": ["id", "parent_record_id", "parent_object", "created_at", "entry_values"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["immutable_value"] }, "message": { "type": "string", "example": "The parent record for a list entry cannot be updated once created." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a list entry", "description": "Deletes a single list entry by its `entry_id`.\n\nRequired scopes: `list_entry:read-write`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read-write", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug identifying the list the entry is in.", "example": "enterprise_sales" }, "required": true, "name": "list", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the entry to delete.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": true, "name": "entry_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values": { "get": { "summary": "List attribute values for a list entry", "description": "Gets all values for a given attribute on a list entry. This endpoint has the ability to return all historic values using the `show_historic` query param. Historic values are sorted from oldest to newest (by `active_from`).\n\nRequired scopes: `list_entry:read`, `list_configuration:read`.", "tags": ["Entries"], "security": [{ "oauth2": ["list_entry:read", "list_configuration:read"] }], "parameters": [{ "schema": { "type": "string", "description": "A UUID or slug identifying the list the entry is in.", "example": "enterprise_sales" }, "required": true, "name": "list", "in": "path" }, { "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": true, "name": "entry_id", "in": "path" }, { "schema": { "type": "string", "description": "A UUID or slug to identify the attribute you want to query values on.", "example": "41252299-f8c7-4b5e-99c9-4ff8321d2f96" }, "required": true, "name": "attribute", "in": "path" }, { "schema": { "type": "boolean", "description": "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`. Can only be set to `true` for attributes which support historic data; the endpoint will throw if set to `true` for non-historic attributes.", "example": true, "default": false }, "required": false, "name": "show_historic", "in": "query" }, { "schema": { "type": "integer", "description": "The maximum number of results to return. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "referenced_actor_type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "description": "The type of the referenced actor. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the referenced actor.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "attribute_type": { "type": "string", "enum": ["actor-reference"], "description": "The attribute type of the value.", "example": "actor-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "referenced_actor_type", "referenced_actor_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "boolean", "description": "A boolean representing whether the checkbox is checked or not. The string values 'true' and 'false' are also accepted.", "example": true }, "attribute_type": { "type": "string", "enum": ["checkbox"], "description": "The attribute type of the value.", "example": "checkbox" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "currency_value": { "type": "number", "description": "A numerical representation of the currency value. A decimal with a max of 4 decimal places.", "example": 99 }, "currency_code": { "type": ["string", "null"], "enum": ["AUD", "BRL", "BEL", "CAD", "CLP", "CNY", "COP", "CZK", "DKK", "EUR", "HKD", "ISK", "INR", "ILS", "JPY", "KRW", "MYR", "MXN", "NTD", "NZD", "NGN", "NOK", "XPF", "PEN", "PHP", "PLN", "GBP", "SAR", "SGD", "ZAR", "SEK", "CHF", "AED", "USD"], "description": "The ISO4217 currency code representing the currency that the value is stored in.", "example": "USD" }, "attribute_type": { "type": "string", "enum": ["currency"], "description": "The attribute type of the value.", "example": "currency" } }, "required": ["active_from", "active_until", "created_by_actor", "currency_value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["date"], "description": "The attribute type of the value.", "example": "date" }, "value": { "type": "string", "description": "A date represents a single calendar year, month and day, independent of timezone. If hours, months, seconds or timezones are provided, they will be trimmed. For example, \"2023\" and \"2023-01\" will be coerced into \"2023-01-01\", and \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T14:00:00\", \"2023-01-02T15:00:00.000000000\", and \"2023-01-02T15:00:00.000000000+02:00\" will all be coerced to \"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\". The maximum date is \"9999-12-31\".", "example": "2023-01-01" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "domain": { "type": "string", "example": "app.attio.com" }, "root_domain": { "type": "string", "example": "attio.com" }, "attribute_type": { "type": "string", "enum": ["domain"], "description": "The attribute type of the value.", "example": "domain" } }, "required": ["active_from", "active_until", "created_by_actor", "domain", "root_domain", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_address": { "type": "string", "example": "alice@app.attio.com" }, "email_domain": { "type": "string", "example": "app.attio.com" }, "email_root_domain": { "type": "string", "example": "attio.com" }, "email_local_specifier": { "type": "string", "example": "alice" }, "attribute_type": { "type": "string", "enum": ["email-address"], "description": "The attribute type of the value.", "example": "email-address" } }, "required": ["active_from", "active_until", "created_by_actor", "original_email_address", "email_address", "email_domain", "email_root_domain", "email_local_specifier", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "target_object": { "type": "string", "description": "A slug identifying the object that the referenced record belongs to.", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "A UUID to identify the referenced record.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "attribute_type": { "type": "string", "enum": ["record-reference"], "description": "The attribute type of the value.", "example": "record-reference" } }, "required": ["active_from", "active_until", "created_by_actor", "target_object", "target_record_id", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "interaction_type": { "type": "string", "enum": ["calendar-event", "call", "chat-thread", "email", "in-person-meeting", "meeting"], "description": "The type of interaction e.g. calendar or email.", "example": "email" }, "interacted_at": { "type": "string", "format": "date-time", "description": "When the interaction occurred.", "example": "2023-01-01T15:00:00.000000000Z" }, "owner_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["interaction"], "description": "The attribute type of the value.", "example": "interaction" } }, "required": ["active_from", "active_until", "created_by_actor", "interaction_type", "interacted_at", "owner_actor", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "line_1": { "type": ["string", "null"], "description": "The first line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "1 Infinite Loop" }, "line_2": { "type": ["string", "null"], "description": "The second line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Block 1" }, "line_3": { "type": ["string", "null"], "description": "The third line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Hilldrop Estate" }, "line_4": { "type": ["string", "null"], "description": "The fourth line of the address. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.", "example": "Westborough" }, "locality": { "type": ["string", "null"], "description": "The town, neighborhood or area the location is in.", "example": "Cupertino" }, "region": { "type": ["string", "null"], "description": "The state, county, province or region that the location is in.", "example": "CA" }, "postcode": { "type": ["string", "null"], "description": "The postcode or zip code for the location. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "95014" }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "description": "The ISO 3166-1 alpha-2 country code for the country this location is in.", "example": "US" }, "latitude": { "type": ["string", "null"], "pattern": "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$", "description": "The latitude of the location. Validated by the regular expression `/^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "37.331741" }, "longitude": { "type": ["string", "null"], "pattern": "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$", "description": "The longitude of the location. Validated by the regular expression `/^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$/`. Values are stored with up to 9 decimal places of precision. Note that this value is not currently represented in the UI but will be persisted and readable through API calls.}", "example": "-122.030333" }, "attribute_type": { "type": "string", "enum": ["location"], "description": "The attribute type of the value.", "example": "location" } }, "required": ["active_from", "active_until", "created_by_actor", "line_1", "line_2", "line_3", "line_4", "locality", "region", "postcode", "country_code", "latitude", "longitude", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "Numbers are persisted as 64 bit floats.", "example": 42 }, "attribute_type": { "type": "string", "enum": ["number"], "description": "The attribute type of the value.", "example": "number" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "first_name": { "type": "string", "description": "The first name.", "example": "Ada" }, "last_name": { "type": "string", "description": "The last name.", "example": "Lovelace" }, "full_name": { "type": "string", "description": "The full name.", "example": "Ada Lovelace" }, "attribute_type": { "type": "string", "enum": ["personal-name"], "description": "The attribute type of the value.", "example": "personal-name" } }, "required": ["active_from", "active_until", "created_by_actor", "first_name", "last_name", "full_name", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "original_phone_number": { "type": "string", "description": "The raw, original phone number, as inputted.", "example": "5558675309" }, "country_code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to.", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "US" }, "phone_number": { "type": "string", "example": "+15558675309" }, "attribute_type": { "type": "string", "enum": ["phone-number"], "description": "The attribute type of the value.", "example": "phone-number" } }, "required": ["active_from", "active_until", "created_by_actor", "original_phone_number", "country_code", "phone_number", "attribute_type"] }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "status": { "$ref": "#/components/schemas/status" }, "attribute_type": { "type": "string", "enum": ["status"], "description": "The attribute type of the value.", "example": "status" } }, "required": ["active_from", "active_until", "created_by_actor", "status", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "number", "description": "A number between 0 and 5 (inclusive) to represent a star rating.", "example": 3 }, "attribute_type": { "type": "string", "enum": ["rating"], "description": "The attribute type of the value.", "example": "rating" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "option": { "$ref": "#/components/schemas/select-option" }, "attribute_type": { "type": "string", "enum": ["select"], "description": "The attribute type of the value.", "example": "select" } }, "required": ["active_from", "active_until", "created_by_actor", "option", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB.", "example": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." }, "attribute_type": { "type": "string", "enum": ["text"], "description": "The attribute type of the value.", "example": "text" } }, "required": ["active_from", "active_until", "created_by_actor", "value", "attribute_type"], "additionalProperties": false }, { "type": "object", "properties": { "active_from": { "type": "string", "format": "date-time", "description": "The point in time at which this value was made \"active\". `active_from` can be considered roughly analogous to `created_at`.", "example": "2023-01-01T15:00:00.000000000Z" }, "active_until": { "type": ["string", "null"], "format": "date-time", "description": "The point in time at which this value was deactivated. If `null`, the value is active.", "example": "2023-01-01T15:00:00.000000000Z" }, "created_by_actor": { "type": "object", "description": "The actor that created this value.", "properties": { "id": { "type": "string", "description": "An ID to identify the actor.", "nullable": true }, "type": { "type": "string", "enum": ["api-token", "workspace-member", "system", "app"], "nullable": true, "description": "The type of actor. [Read more information on actor types here](/docs/actors)." } }, "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "attribute_type": { "type": "string", "enum": ["timestamp"], "description": "The attribute type of the value.", "example": "timestamp" }, "value": { "type": "string", "description": "A timestamp value represents a single, universal moment in time using an ISO 8601 formatted string. This means that a timestamp consists of a date, a time (with nanosecond precision), and a time zone. Attio will coerce timestamps which do not provide full nanosecond precision and UTC is assumed if no time zone is provided. For example, \"2023\", \"2023-01\", \"2023-01-02\", \"2023-01-02T13:00\", \"2023-01-02T13:00:00\", and \"2023-01-02T13:00:00.000000000\" will all be coerced to \"2023-01-02T13:00:00.000000000Z\". Timestamps are always returned in UTC. For example, writing a timestamp value using the string \"2023-01-02T13:00:00.000000000+02:00\" will result in the value \"2023-01-02T11:00:00.000000000Z\" being returned. The maximum date is \"9999-12-31T23:59:59.999999999Z\".", "format": "date", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["active_from", "active_until", "created_by_actor", "attribute_type", "value"], "additionalProperties": false }] } } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "List with slug/ID \"enterprise_sales\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/workspace_members": { "get": { "summary": "List workspace members", "description": "Lists all workspace members in the workspace.\n\nRequired scopes: `user_management:read`.", "tags": ["Workspace members"], "security": [{ "oauth2": ["user_management:read"] }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/workspace-member" } } }, "required": ["data"], "description": "Success" } } } } } } }, "/v2/workspace_members/{workspace_member_id}": { "get": { "summary": "Get a workspace member", "description": "Gets a single workspace member by ID.\n\nRequired scopes: `user_management:read`.", "tags": ["Workspace members"], "security": [{ "oauth2": ["user_management:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID to identify the workspace member.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" }, "required": true, "name": "workspace_member_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/workspace-member" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Workspace member with ID \"50cf242c-7fa3-4cad-87d0-75b1af71c57b\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/notes": { "get": { "summary": "List notes", "description": "List notes for all records or for a specific record.\n\nRequired scopes: `note:read`, `object_configuration:read`, `record_permission:read`.", "tags": ["Notes"], "security": [{ "oauth2": ["note:read", "object_configuration:read", "record_permission:read"] }], "parameters": [{ "schema": { "type": "integer", "description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string", "description": "The slug or ID of the parent object the notes belong to.", "example": "people" }, "required": false, "name": "parent_object", "in": "query" }, { "schema": { "type": "string", "format": "uuid", "description": "The ID of the parent record the notes belong to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": false, "name": "parent_record_id", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/note" } } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "post": { "summary": "Create a note", "description": "Creates a new note for a given record.\n\nRequired scopes: `note:read-write`, `object_configuration:read`, `record_permission:read`.", "tags": ["Notes"], "security": [{ "oauth2": ["note:read-write", "object_configuration:read", "record_permission:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "parent_object": { "type": "string", "description": "The ID or slug of the parent object the note belongs to.", "example": "people" }, "parent_record_id": { "type": "string", "format": "uuid", "description": "The ID of the parent record the note belongs to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "title": { "type": "string", "description": "The note title. The title is plaintext only and has no formatting.", "example": "Initial Prospecting Call Summary" }, "format": { "type": "string", "enum": ["plaintext", "markdown"], "description": "Specify the format for the note's content. Choose from:\n- `plaintext`: Standard text format where `\\n` signifies a new line.\n- `markdown`: Enables rich text formatting using a subset of Markdown syntax:\n  - **Headings**: Levels 1-3 (`#`, `##`, `###`).\n  - **Lists**: Unordered (`-`, `*`, `+`) and ordered (`1.`, `2.`).\n  - **Text styles**: Bold (`**bold**` or `__bold__`), italic (`*italic*` or `_italic_`), strikethrough (`~~strikethrough~~`), and highlight (`==highlighted==`).\n  - **Links**: Standard Markdown links (`[link text](https://example.com)`).\n\n  *Note: While the Attio interface supports image embeds, they cannot currently be added or retrieved via the API's markdown format.*" }, "content": { "type": "string", "description": "The main content of the note, formatted according to the value provided in the `format` field. Use `\\n` for line breaks in `plaintext`. For `markdown`, utilize the supported syntax elements to structure and style your note.", "example": "# Meeting Recap: Q4 Planning\n\n**Date:** 2023-10-26\n**Attendees:** Alex, Jamie, Casey\n\n## Key Discussion Points\n\n- Reviewed Q3 performance metrics.\n- Brainstormed key initiatives for Q4.\n- Discussed budget allocation for ==Project Phoenix==.\n\n## Action Items\n\n1. Alex to finalize Q4 roadmap by EOD Friday.\n2. Jamie to schedule follow-up with [Marketing Team](https://app.attio.com/teams/marketing).\n3. Casey to draft initial budget for ~~Project Chimera~~ (now deferred).\n\n*Next steps: Review draft roadmap next week.*" }, "created_at": { "type": "string", "description": "`created_at` will default to the current time. However, if you wish to backdate a note for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed.", "example": "2023-01-01T15:00:00.000000000Z" } }, "required": ["parent_object", "parent_record_id", "title", "format", "content"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/note" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/notes/{note_id}": { "get": { "summary": "Get a note", "description": "Get a single note by ID.\n\nRequired scopes: `note:read`, `object_configuration:read`, `record_permission:read`.", "tags": ["Notes"], "security": [{ "oauth2": ["note:read", "object_configuration:read", "record_permission:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the note.", "example": "ff3f3bd4-40f4-4f80-8187-cd02385af424" }, "required": true, "name": "note_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/note" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Note with ID \"ff3f3bd4-40f4-4f80-8187-cd02385af424\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a note", "description": "Delete a single note by ID.\n\nRequired scopes: `note:read-write`.", "tags": ["Notes"], "security": [{ "oauth2": ["note:read-write"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the note to delete.", "example": "ff3f3bd4-40f4-4f80-8187-cd02385af424" }, "required": true, "name": "note_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Note with ID \"ff3f3bd4-40f4-4f80-8187-cd02385af424\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/tasks": { "get": { "summary": "List tasks", "description": "List all tasks. Results are sorted by creation date, from oldest to newest.\n\nRequired scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`.", "tags": ["Tasks"], "security": [{ "oauth2": ["task:read", "object_configuration:read", "record_permission:read", "user_management:read"] }], "parameters": [{ "schema": { "type": "integer", "description": "The maximum number of results to return. Defaults to 500. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. Defaults to 0. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string", "enum": ["created_at:asc", "created_at:desc"], "description": "Optionally sort the results. \"created_at:asc\" returns oldest results first, \"created_at:desc\" returns the newest results first. If unspecified, defaults to \"created_at:asc\" (oldest results first).", "example": "created_at:desc" }, "required": false, "name": "sort", "in": "query" }, { "schema": { "type": "string", "description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should identify the object that the linked record belongs to. For example, if filtering to tasks that link to a specific person record, this parameter should be `people`. If provided, `linked_record_id` must also be provided.", "example": "people" }, "required": false, "name": "linked_object", "in": "query" }, { "schema": { "type": "string", "format": "uuid", "description": "Pass a value to this parameter to filter results to only those tasks that contain the specified record in the `linked_records` property of the task. This parameter should contain the record ID of the linked record. If provided, `linked_object` must also be provided.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": false, "name": "linked_record_id", "in": "query" }, { "schema": { "type": ["string", "null"], "description": "Filter tasks by workspace member assignees. Workspace members can be referenced by either their email address or ID. Pass an empty value or the string `null` to find tasks with no assignee.", "examples": ["50cf242c-7fa3-4cad-87d0-75b1af71c57b", "alice@attio.com"] }, "required": false, "name": "assignee", "in": "query" }, { "schema": { "type": "boolean", "description": "Filter tasks by whether they have been completed. By default, both completed and non-completed tasks are returned. Specify `true` to only return completed tasks, or `false` to only return non-completed tasks.", "example": true }, "required": false, "name": "is_completed", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/task" } } }, "required": ["data"], "description": "Success" } } } } } }, "post": { "summary": "Create a task", "description": "Creates a new task.\n\nAt present, tasks can only be created from plaintext without record reference formatting.\n\nRequired scopes: `task:read-write`, `object_configuration:read`, `record_permission:read`, `user_management:read`.", "tags": ["Tasks"], "security": [{ "oauth2": ["task:read-write", "object_configuration:read", "record_permission:read", "user_management:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "content": { "type": "string", "description": "The text content of the task, in the format specified by the `format` property.", "example": "Follow up on current software solutions" }, "format": { "type": "string", "enum": ["plaintext"], "description": "The format of the task content to be created. Rich text formatting, links and @references are not supported." }, "deadline_at": { "type": ["string", "null"], "description": "The deadline of the task, in ISO 8601 format.", "example": "2023-01-01T15:00:00.000000000Z" }, "is_completed": { "type": "boolean", "description": "Whether the task has been completed.", "example": false }, "linked_records": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "target_object": { "type": "string", "description": "The ID or slug of the parent object the tasks refers to. This can reference both standard and custom objects.`", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "The ID of the parent record the task refers to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } }, "required": ["target_object", "target_record_id"] }, { "type": "object", "example": { "target_object": "people", "matching_attribute_id_123": [{ "value": "matching_attribute_id_123" }] }, "properties": { "target_object": { "type": "string", "example": "people", "description": "A UUID or slug to identify the object that the referenced record belongs to." }, "[slug_or_id_of_matching_attribute]": { "type": "array", "description": "In addition to referencing records directly by record ID, you may also reference by a matching attribute of your choice. For example, if you want to add a reference to the person record with email \"alice@website.com\", you should pass a value with `target_object` set to `\"people\"` and `email_addresses` set to `[{email_address:\"alice@website.com\"}]`. The key should be the slug or ID of the matching attribute you would like to use and the value should be an array containing a single value of the appropriate attribute type (as specified below). Matching on multiple values is not currently supported. Matching attributes must be unique. This process is similar to how you use the `matching_attribute` query param in Attio's [assert endpoints](/rest-api/endpoint-reference/records/assert-a-record).", "items": { "anyOf": [{ "type": "object", "properties": { "domain": { "type": "string", "example": "app.attio.com", "description": "The full domain of the website." } } }, { "type": "object", "properties": { "email_address": { "type": "string", "example": "alice@app.attio.com", "description": "An email address string" } } }, { "type": "object", "properties": { "value": { "type": "number", "example": 17224912, "description": "Numbers are persisted as 64 bit floats." } } }, { "type": "object", "properties": { "original_phone_number": { "type": "string", "example": "07234172834", "description": "The raw, original phone number, as inputted." }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "GB", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to." } } }, { "type": "object", "properties": { "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB." } } }] } } }, "required": ["target_object", "[slug_or_id_of_matching_attribute]"] }] }, "description": "Records linked to the task. Creating record links within task content text is not possible via the API at present." }, "assignees": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "referenced_actor_type": { "type": "string", "enum": ["workspace-member"], "description": "The actor type of the task assignee. Only `workspace-member` actors can be assigned to tasks. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": "string", "format": "uuid", "description": "The ID of the actor assigned to this task.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["referenced_actor_type", "referenced_actor_id"] }, { "type": "object", "properties": { "workspace_member_email_address": { "type": "string", "description": "Workspace member actors can be referenced by email address as well as actor ID.", "example": "alice@attio.com" } }, "required": ["workspace_member_email_address"], "additionalProperties": false }] }, "description": "Workspace members assigned to this task." } }, "required": ["content", "format", "deadline_at", "is_completed", "linked_records", "assignees"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/task" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "Only standard or custom object records can be linked to." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"people\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/tasks/{task_id}": { "get": { "summary": "Get a task", "description": "Get a single task by ID.\n\nRequired scopes: `task:read`, `object_configuration:read`, `record_permission:read`, `user_management:read`.", "tags": ["Tasks"], "security": [{ "oauth2": ["task:read", "object_configuration:read", "record_permission:read", "user_management:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "The ID of the task.", "example": "649e34f4-c39a-4f4d-99ef-48a36bef8f04" }, "required": true, "name": "task_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/task" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Could not find Task with ID \"649e34f4-c39a-4f4d-99ef-48a36bef8f04\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update a task", "description": "Updates an existing task by `task_id`. At present, only the `deadline_at`, `is_completed`, `linked_records`, and `assignees` fields can be updated.\n\nRequired scopes: `task:read-write`, `object_configuration:read`, `record_permission:read`, `user_management:read`.", "tags": ["Tasks"], "security": [{ "oauth2": ["task:read-write", "object_configuration:read", "record_permission:read", "user_management:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "The ID of the task to update.", "example": "649e34f4-c39a-4f4d-99ef-48a36bef8f04" }, "required": true, "name": "task_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deadline_at": { "type": ["string", "null"], "description": "The deadline of the task, in ISO 8601 format.", "example": "2023-01-01T15:00:00.000000000Z" }, "is_completed": { "type": "boolean", "description": "Whether the task has been completed.", "example": false }, "linked_records": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "target_object": { "type": "string", "description": "The ID or slug of the parent object the tasks refers to. This can reference both standard and custom objects.`", "example": "people" }, "target_record_id": { "type": "string", "format": "uuid", "description": "The ID of the parent record the task refers to.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" } }, "required": ["target_object", "target_record_id"] }, { "type": "object", "example": { "target_object": "people", "matching_attribute_id_123": [{ "value": "matching_attribute_id_123" }] }, "properties": { "target_object": { "type": "string", "example": "people", "description": "A UUID or slug to identify the object that the referenced record belongs to." }, "[slug_or_id_of_matching_attribute]": { "type": "array", "description": "In addition to referencing records directly by record ID, you may also reference by a matching attribute of your choice. For example, if you want to add a reference to the person record with email \"alice@website.com\", you should pass a value with `target_object` set to `\"people\"` and `email_addresses` set to `[{email_address:\"alice@website.com\"}]`. The key should be the slug or ID of the matching attribute you would like to use and the value should be an array containing a single value of the appropriate attribute type (as specified below). Matching on multiple values is not currently supported. Matching attributes must be unique. This process is similar to how you use the `matching_attribute` query param in Attio's [assert endpoints](/rest-api/endpoint-reference/records/assert-a-record).", "items": { "anyOf": [{ "type": "object", "properties": { "domain": { "type": "string", "example": "app.attio.com", "description": "The full domain of the website." } } }, { "type": "object", "properties": { "email_address": { "type": "string", "example": "alice@app.attio.com", "description": "An email address string" } } }, { "type": "object", "properties": { "value": { "type": "number", "example": 17224912, "description": "Numbers are persisted as 64 bit floats." } } }, { "type": "object", "properties": { "original_phone_number": { "type": "string", "example": "07234172834", "description": "The raw, original phone number, as inputted." }, "country_code": { "type": ["string", "null"], "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "SS", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "BQ", "KP", "SX"], "example": "GB", "description": "The ISO 3166-1 alpha-2 country code representing the country that this phone number belongs to." } } }, { "type": "object", "properties": { "value": { "type": "string", "description": "A raw text field. Values are limited to 10MB." } } }] } } }, "required": ["target_object", "[slug_or_id_of_matching_attribute]"] }] }, "description": "Records linked to the task. Creating record links within task content text is not possible via the API at present." }, "assignees": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "referenced_actor_type": { "type": "string", "enum": ["workspace-member"], "description": "The actor type of the task assignee. Only `workspace-member` actors can be assigned to tasks. [Read more information on actor types here](/docs/actors).", "example": "workspace-member" }, "referenced_actor_id": { "type": "string", "format": "uuid", "description": "The ID of the actor assigned to this task.", "example": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "required": ["referenced_actor_type", "referenced_actor_id"] }, { "type": "object", "properties": { "workspace_member_email_address": { "type": "string", "description": "Workspace member actors can be referenced by email address as well as actor ID.", "example": "alice@attio.com" } }, "required": ["workspace_member_email_address"], "additionalProperties": false }] }, "description": "Workspace members assigned to this task." } }, "additionalProperties": false } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/task" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "Only standard or custom object records can be linked to." } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Object with slug/ID \"649e34f4-c39a-4f4d-99ef-48a36bef8f04\" not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a task", "description": "Delete a task by ID.\n\nRequired scopes: `task:read-write`.", "tags": ["Tasks"], "security": [{ "oauth2": ["task:read-write"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "The ID of the task to delete.", "example": "649e34f4-c39a-4f4d-99ef-48a36bef8f04" }, "required": true, "name": "task_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Could not find Task with ID \"649e34f4-c39a-4f4d-99ef-48a36bef8f04\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/threads": { "get": { "summary": "List threads", "description": "List threads of comments on a record or list entry.\n\nTo view threads on records, you will need the `object_configuration:read` and `record_permission:read` scopes.\n\nTo view threads on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.\n\nRequired scopes: `comment:read`.", "tags": ["Threads"], "security": [{ "oauth2": ["comment:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "Use this parameter to filter to threads on a specific record. Must be passed with `object`.", "example": "891dcbfc-9141-415d-9b2a-2238a6cc012d" }, "required": false, "name": "record_id", "in": "query" }, { "schema": { "type": "string", "description": "Use this parameter to filter to threads on a specific record. Must be passed with `record_id`. Accepts either a slug or an ID.", "example": "people" }, "required": false, "name": "object", "in": "query" }, { "schema": { "type": "string", "format": "uuid", "description": "Use this parameter to filter to threads on a specific entry. Must be passed with `list`.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" }, "required": false, "name": "entry_id", "in": "query" }, { "schema": { "type": "string", "description": "Use this parameter to filter to threads on a specific entry. Must be passed with `entry_id`. Accepts either a slug or an ID.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "required": false, "name": "list", "in": "query" }, { "schema": { "type": "integer", "description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/thread" } } }, "required": ["data"], "description": "Success" } } } } } } }, "/v2/threads/{thread_id}": { "get": { "summary": "Get a thread", "description": "Get all comments in a thread.\n\nTo view threads on records, you will need the `object_configuration:read` and `record_permission:read` scopes.\n\nTo view threads on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.\n\nRequired scopes: `comment:read`.", "tags": ["Threads"], "security": [{ "oauth2": ["comment:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the thread.", "example": "a649e4d9-435c-43fb-83ba-847b4876f27a" }, "required": true, "name": "thread_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/thread" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Thread with ID \"a649e4d9-435c-43fb-83ba-847b4876f27a\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/comments": { "post": { "summary": "Create a comment", "description": "Creates a new comment related to an existing thread, record or entry.\n\nTo create comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.\n\nTo create comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.\n\nRequired scopes: `comment:read-write`.", "tags": ["Comments"], "security": [{ "oauth2": ["comment:read-write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [{ "type": "object", "properties": { "format": { "type": "string", "enum": ["plaintext"], "description": "The format that the comment content is provided in. The `plaintext` format uses the line feed character `\\n` to create new lines within the note content. Rich text formatting and links are not supported." }, "content": { "type": "string", "description": "The content of the comment itself. Workspace members can be mentioned using their email address, otherwise email addresses will be presented to users as clickable mailto links.", "example": "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": "object", "properties": { "type": { "type": "string", "enum": ["workspace-member"] }, "id": { "type": "string", "format": "uuid" } }, "required": ["type", "id"], "description": "The workspace member who wrote this comment. Note that other types of actors are not currently supported.", "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "`created_at` will default to the current time. However, if you wish to backdate a comment for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed.", "example": "2023-01-01T15:00:00.000000000Z" }, "thread_id": { "type": "string", "format": "uuid", "description": "If responding to an existing thread, this would be the ID of that thread.", "example": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" } }, "required": ["format", "content", "author", "thread_id"], "additionalProperties": false }, { "type": "object", "properties": { "format": { "type": "string", "enum": ["plaintext"], "description": "The format that the comment content is provided in. The `plaintext` format uses the line feed character `\\n` to create new lines within the note content. Rich text formatting and links are not supported." }, "content": { "type": "string", "description": "The content of the comment itself. Workspace members can be mentioned using their email address, otherwise email addresses will be presented to users as clickable mailto links.", "example": "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": "object", "properties": { "type": { "type": "string", "enum": ["workspace-member"] }, "id": { "type": "string", "format": "uuid" } }, "required": ["type", "id"], "description": "The workspace member who wrote this comment. Note that other types of actors are not currently supported.", "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "`created_at` will default to the current time. However, if you wish to backdate a comment for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed.", "example": "2023-01-01T15:00:00.000000000Z" }, "record": { "type": "object", "properties": { "object": { "type": "string", "description": "If creating a top-level comment on a record, this is the slug or ID of that object.", "example": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }, "record_id": { "type": "string", "format": "uuid", "description": "If creating a top-level comment on a record, this is the ID of that record.", "example": "bf071e1f-6035-429d-b874-d83ea64ea13b" } }, "required": ["object", "record_id"] } }, "required": ["format", "content", "author", "record"], "additionalProperties": false }, { "type": "object", "properties": { "format": { "type": "string", "enum": ["plaintext"], "description": "The format that the comment content is provided in. The `plaintext` format uses the line feed character `\\n` to create new lines within the note content. Rich text formatting and links are not supported." }, "content": { "type": "string", "description": "The content of the comment itself. Workspace members can be mentioned using their email address, otherwise email addresses will be presented to users as clickable mailto links.", "example": "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": "object", "properties": { "type": { "type": "string", "enum": ["workspace-member"] }, "id": { "type": "string", "format": "uuid" } }, "required": ["type", "id"], "description": "The workspace member who wrote this comment. Note that other types of actors are not currently supported.", "example": { "type": "workspace-member", "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b" } }, "created_at": { "type": "string", "description": "`created_at` will default to the current time. However, if you wish to backdate a comment for migration or other purposes, you can override with a custom `created_at` value. Note that dates before 1970 or in the future are not allowed.", "example": "2023-01-01T15:00:00.000000000Z" }, "entry": { "type": "object", "properties": { "list": { "type": "string", "description": "If creating a top-level comment on a list entry, this is the slug or ID of that list.", "example": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0" }, "entry_id": { "type": "string", "description": "If creating a top-level comment on a list entry, this is the ID of that entry.", "example": "2e6e29ea-c4e0-4f44-842d-78a891f8c156" } }, "required": ["list", "entry_id"] } }, "required": ["format", "content", "author", "entry"], "additionalProperties": false }] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/comment" } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["value_not_found"] }, "message": { "type": "string", "example": "The referenced Thread could not be found, it might have been deleted." } }, "required": ["statusCode", "type", "code", "message"], "description": "Bad Request" } } } } } } }, "/v2/comments/{comment_id}": { "get": { "summary": "Get a comment", "description": "Get a single comment by ID.\n\nTo view comments on records, you will need the `object_configuration:read` and `record_permission:read` scopes.\n\nTo view comments on list entries, you will need the `list_configuration:read` and `list_entry:read` scopes.\n\nRequired scopes: `comment:read`.", "tags": ["Comments"], "security": [{ "oauth2": ["comment:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the comment.", "example": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "required": true, "name": "comment_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/comment" } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Comment with ID \"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a comment", "description": "Deletes a comment by ID. If deleting a comment at the head of a thread, all messages in the thread are also deleted.\n\nRequired scopes: `comment:read-write`.", "tags": ["Comments"], "security": [{ "oauth2": ["comment:read-write"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "The ID of the comment to delete.", "example": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2" }, "required": true, "name": "comment_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Could not find Comment with ID \"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2\"." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/webhooks": { "get": { "summary": "List webhooks", "description": "Get all of the webhooks in your workspace.\n\nRequired scopes: `webhook:read`.", "tags": ["Webhooks"], "security": [{ "oauth2": ["webhook:read"] }], "parameters": [{ "schema": { "type": "integer", "description": "The maximum number of results to return, between 10 and 100, defaults to 10. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 10 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "integer", "description": "The number of results to skip over before returning, defaults to 0. See the [full guide to pagination here](/rest-api/how-to/pagination).", "example": 5 }, "required": false, "name": "offset", "in": "query" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." }, "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the webhook belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "webhook_id": { "type": "string", "format": "uuid", "description": "The ID of the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" } }, "required": ["workspace_id", "webhook_id"] }, "status": { "type": "string", "enum": ["active", "degraded", "inactive"], "description": "The state of the webhook. Webhooks marked as active and degraded will receive events, inactive ones will not. If a webhook remains in the degraded state for 7 days, it will be marked inactive.", "example": "active" }, "created_at": { "type": "string", "description": "When the webhook was created.", "example": "2023-04-27T13:22:49.061281000Z" } }, "required": ["target_url", "subscriptions", "id", "status", "created_at"] } } }, "required": ["data"], "description": "Success" } } } } } }, "post": { "summary": "Create a webhook", "description": "Create a webhook and associated subscriptions.\n\nRequired scopes: `webhook:read-write`.", "tags": ["Webhooks"], "security": [{ "oauth2": ["webhook:read-write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." } }, "required": ["target_url", "subscriptions"] } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." }, "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the webhook belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "webhook_id": { "type": "string", "format": "uuid", "description": "The ID of the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" } }, "required": ["workspace_id", "webhook_id"] }, "status": { "type": "string", "enum": ["active", "degraded", "inactive"], "description": "The state of the webhook. Webhooks marked as active and degraded will receive events, inactive ones will not. If a webhook remains in the degraded state for 7 days, it will be marked inactive.", "example": "active" }, "created_at": { "type": "string", "description": "When the webhook was created.", "example": "2023-04-27T13:22:49.061281000Z" }, "secret": { "type": "string", "description": "The key which is used to sign the webhook events. This is only shown when setting up the webhook initially.", "example": "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb" } }, "required": ["target_url", "subscriptions", "id", "status", "created_at", "secret"] } }, "required": ["data"], "description": "Success" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [400] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["validation_type"] }, "message": { "type": "string", "example": "Related list not found" } }, "required": ["status_code", "type", "code", "message"], "description": "Bad Request" } } } } } } }, "/v2/webhooks/{webhook_id}": { "get": { "summary": "Get a webhook", "description": "Get a single webhook.\n\nRequired scopes: `webhook:read`.", "tags": ["Webhooks"], "security": [{ "oauth2": ["webhook:read"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" }, "required": true, "name": "webhook_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." }, "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the webhook belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "webhook_id": { "type": "string", "format": "uuid", "description": "The ID of the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" } }, "required": ["workspace_id", "webhook_id"] }, "status": { "type": "string", "enum": ["active", "degraded", "inactive"], "description": "The state of the webhook. Webhooks marked as active and degraded will receive events, inactive ones will not. If a webhook remains in the degraded state for 7 days, it will be marked inactive.", "example": "active" }, "created_at": { "type": "string", "description": "When the webhook was created.", "example": "2023-04-27T13:22:49.061281000Z" } }, "required": ["target_url", "subscriptions", "id", "status", "created_at"] } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Webhook with ID \"23e42eaf-323a-41da-b5bb-fd67eebda553\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "patch": { "summary": "Update a webhook", "description": "Update a webhook and associated subscriptions.\n\nRequired scopes: `webhook:read-write`.", "tags": ["Webhooks"], "security": [{ "oauth2": ["webhook:read-write"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID which identifies the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" }, "required": true, "name": "webhook_id", "in": "path" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." } } } }, "required": ["data"] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "target_url": { "type": "string", "format": "uri", "pattern": "^https:\\/\\/.*", "description": "URL where the webhook events will be delivered to.", "example": "https://example.com/webhook" }, "subscriptions": { "type": "array", "items": { "type": "object", "properties": { "event_type": { "type": "string", "enum": ["comment.created", "comment.resolved", "comment.unresolved", "comment.deleted", "list.created", "list.updated", "list.deleted", "list-attribute.created", "list-attribute.updated", "list-entry.created", "list-entry.updated", "list-entry.deleted", "object-attribute.created", "object-attribute.updated", "note.created", "note-content.updated", "note.updated", "note.deleted", "record.created", "record.merged", "record.updated", "record.deleted", "task.created", "task.updated", "task.deleted", "workspace-member.created"], "description": "Type of event the webhook is subscribed to.", "example": "note.created" }, "filter": { "anyOf": [{ "type": "object", "properties": { "$or": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$or"] }, { "type": "object", "properties": { "$and": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }, { "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string", "enum": ["not_equals"] }, "value": { "type": "string" } }, "required": ["field", "operator", "value"] }] } } }, "required": ["$and"] }, { "type": "null" }], "description": "Filters to determine whether the webhook event should be sent. If null, the filter always passes.", "example": { "$and": [{ "field": "parent_object_id", "operator": "equals", "value": "97052eb9-e65e-443f-a297-f2d9a4a7f795" }] } } }, "required": ["event_type", "filter"] }, "description": "One or more events the webhook is subscribed to." }, "id": { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the webhook belongs to.", "example": "14beef7a-99f7-4534-a87e-70b564330a4c" }, "webhook_id": { "type": "string", "format": "uuid", "description": "The ID of the webhook.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" } }, "required": ["workspace_id", "webhook_id"] }, "status": { "type": "string", "enum": ["active", "degraded", "inactive"], "description": "The state of the webhook. Webhooks marked as active and degraded will receive events, inactive ones will not. If a webhook remains in the degraded state for 7 days, it will be marked inactive.", "example": "active" }, "created_at": { "type": "string", "description": "When the webhook was created.", "example": "2023-04-27T13:22:49.061281000Z" } }, "required": ["target_url", "subscriptions", "id", "status", "created_at"] } }, "required": ["data"], "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Webhook with ID \"23e42eaf-323a-41da-b5bb-fd67eebda553\" was not found." } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } }, "delete": { "summary": "Delete a webhook", "description": "Delete a webhook by ID.\n\nRequired scopes: `webhook:read-write`.", "tags": ["Webhooks"], "security": [{ "oauth2": ["webhook:read-write"] }], "parameters": [{ "schema": { "type": "string", "format": "uuid", "description": "A UUID identifying the webhook to delete.", "example": "23e42eaf-323a-41da-b5bb-fd67eebda553" }, "required": true, "name": "webhook_id", "in": "path" }], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "description": "Success" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status_code": { "type": "number", "enum": [404] }, "type": { "type": "string", "enum": ["invalid_request_error"] }, "code": { "type": "string", "enum": ["not_found"] }, "message": { "type": "string", "example": "Webhook not found" } }, "required": ["status_code", "type", "code", "message"], "description": "Not Found" } } } } } } }, "/v2/self": { "get": { "summary": "Identify", "description": "Identify the current access token, the workspace it is linked to, and any permissions it has.", "tags": ["Meta"], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [{ "type": "object", "properties": { "active": { "type": "boolean", "enum": [false] } }, "required": ["active"] }, { "type": "object", "properties": { "active": { "type": "boolean", "description": "Whether the token is currently active and usable." }, "scope": { "type": "string", "description": "A space-separated list of scopes associated with this token" }, "client_id": { "type": "string", "description": "The app ID of the OAuth application that requested this token" }, "token_type": { "type": "string", "enum": ["Bearer"], "description": "The type of token, always Bearer for tokens acquired via the OAuth 2.0 flow." }, "exp": { "type": ["number", "null"], "description": "The time at which this token will expire, if set, as a number of seconds since January 1 1970 UTC." }, "iat": { "type": "number", "description": "The time at which this token was issued, as a number of seconds since January 1 1970 UTC." }, "sub": { "type": "string", "format": "uuid", "description": "Since Bearer tokens grant Workspace-level permissions, this property contains the workspace_id." }, "aud": { "type": "string", "description": "The intended audience for this token, for Bearer tokens this is the same as the client_id." }, "iss": { "type": "string", "enum": ["attio.com"], "description": "The issuer of the token. Always attio.com" }, "authorized_by_workspace_member_id": { "type": ["string", "null"], "format": "uuid", "description": "The ID of the workspace member who authorised this token initially, if known" }, "workspace_id": { "type": "string", "format": "uuid", "description": "The ID of the workspace the token is scoped to." }, "workspace_name": { "type": "string", "description": "The name of the workspace the token is scoped to." }, "workspace_slug": { "type": "string", "description": "The slug of the workspace the token is scoped to." }, "workspace_logo_url": { "type": ["string", "null"], "format": "uri", "description": "The logo URL of the workspace the token is scoped to." } }, "required": ["active", "scope", "client_id", "token_type", "exp", "iat", "sub", "aud", "iss", "authorized_by_workspace_member_id", "workspace_id", "workspace_name", "workspace_slug", "workspace_logo_url"] }] } } } } } } } }, "webhooks": {} }