attio-js

{ "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" }, "summary": "Attio is a CRM platform which is highly customisable, incredibly powerful and data-driven. The public API allows you to manipulate records, lists, notes, tasks and more. You can find more information about the Attio API in the [official docs](https://docs.attio.com/docs/overview). Unfortunately, an official JavaScript or TypeScript SDK has not been released yet. In the meantime, we maintain this unofficial SDK to bridge the gap until an official SDK becomes available." }, "tags": [ { "name": "Objects", "description": "Objects are the core data models inside of Attio. They contain standard objects, such as [people](/docs/standard-objects-people), [companies](/docs/standard-objects-companies) or [deals](/docs/standard-objects-deals), and custom objects that are specific to your use-case. See our [data model guide](/docs/data-model) 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 [data model guide](/docs/data-model) for more information." }, { "name": "Records", "description": "Records are individual instances of objects e.g. a specific [person](/docs/standard-objects-people) or [company](/docs/standard-objects-companies). See our [data model guide](/docs/data-model) 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 [data model guide](/docs/data-model) 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 [data model guide](/docs/data-model) 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": "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](/reference/get_v2-comments-comment-id) on either a record or entry." }, { "name": "Comments", "description": "Comments are messages on a [thread](/reference/get_v2-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": [ { "apiKey": [] } ], "servers": [ { "url": "https://api.attio.com", "description": "Production" } ], "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer" } }, "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](/reference/put_v2-objects-object-records).", "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" ], "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" ], "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+)?)$/`. 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+)?)$/`", "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" ], "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 opt