Records are individual instances of Objects e.g. a specific person or company.
Lists people, company or other Records, with the option to filter and sort results.
record_permission:readrequiredobject_configuration:readrequiredobjectstringREQUIRED
A UUID or slug to identify the Object to list Records for.
limitnumberThe maximum number of results to return. Defaults to 500 See the full guide to pagination here.
sortslistAn object used to sort results. See the full guide to filtering and sorting here.
Each item in the list is one of the types described below.
filterobjectAn object used to filter results to a subset of records. See the full guide to filtering and sorting here.
offsetnumberThe number of results to skip over before returning. Defaults to 0. See the full guide to pagination here.
Status code
Description
curl https://api.attio.com/v2/objects/people/records/query \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-d @- << EOF{"limit": 10,"sorts": [{"field": "last_name","attribute": "name","direction": "asc"}],"filter": {"name": "Ada Lovelace"},"offset": 0}EOF
200 - Success
{"data": [{"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"values": {"actor_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}],"checkbox_slug_example": [{"value": true,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "checkbox","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"currency_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","currency_code": "USD","attribute_type": "currency","currency_value": 99,"created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"date_slug_example": [{"value": "2022-11-21T13:22:49.061281000Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "date","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"domain_slug_example": [{"domain": "app.attio.com","active_from": "2022-11-21T13:22:49.061281000Z","root_domain": "attio.com","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "domain","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"email_address_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","email_domain": "app.attio.com","attribute_type": "email-address","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"email_root_domain": "attio.com","email_local_specifier": "alice",}],"record_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"}],"interaction_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","owner_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"active_until": "2022-11-21T13:22:49.061281000Z","interacted_at": "2023-06-09T20:31:13.326Z","attribute_type": "interaction","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"interaction_type": "email"}],"location_slug_example": [{"line_1": "1 Infinite Loop","line_2": "Block 1","line_3": "Hilldrop Estate","line_4": "Westborough","region": "CA","latitude": "37.331741","locality": "Cupertino","postcode": "95014","longitude": "-122.030333","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "US","attribute_type": "location","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"number_slug_example": [{"value": 42,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"personal_name_slug_example": [{"full_name": "Ada Lovelace","last_name": "Lovelace","first_name": "Ada","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "personal-name","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"phone_number_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "GB","phone_number": "+447234172834","attribute_type": "phone-number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"original_phone_number": "07234172834"}],"status_slug_example": [{"status": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "In Progress","is_archived": false,"celebration_enabled": false,"target_time_in_status": "P0Y0M1DT0H0M0S"},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "status","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"rating_slug_example": [{"value": 3,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "rating","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"select_slug_example": [{"option": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "Medium","is_archived": false},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "select","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"text_slug_example": [{"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "text","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"timestamp_slug_example": [{"value": "2020-06-02T23:58:40.347847393Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "timestamp","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}]}
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 instead. Please note, logo_url and avatar_url attributes cannot currently be set via the API.
object_configuration:readrequiredrecord_permission:read-writerequiredobjectstringREQUIRED
The UUID or slug identifying the Object the created Record should belong to.
dataobjectREQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/people/records \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-d @- << EOF{"data": {"values": {"41252299-f8c7-4b5e-99c9-4ff8321d2f96": [{"value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."}]}}}EOF
200 - Success
{"data": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"values": {"actor_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}],"checkbox_slug_example": [{"value": true,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "checkbox","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"currency_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","currency_code": "USD","attribute_type": "currency","currency_value": 99,"created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"date_slug_example": [{"value": "2022-11-21T13:22:49.061281000Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "date","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"domain_slug_example": [{"domain": "app.attio.com","active_from": "2022-11-21T13:22:49.061281000Z","root_domain": "attio.com","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "domain","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"email_address_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","email_domain": "app.attio.com","attribute_type": "email-address","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"email_root_domain": "attio.com","email_local_specifier": "alice",}],"record_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"}],"interaction_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","owner_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"active_until": "2022-11-21T13:22:49.061281000Z","interacted_at": "2023-06-09T20:31:13.326Z","attribute_type": "interaction","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"interaction_type": "email"}],"location_slug_example": [{"line_1": "1 Infinite Loop","line_2": "Block 1","line_3": "Hilldrop Estate","line_4": "Westborough","region": "CA","latitude": "37.331741","locality": "Cupertino","postcode": "95014","longitude": "-122.030333","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "US","attribute_type": "location","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"number_slug_example": [{"value": 42,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"personal_name_slug_example": [{"full_name": "Ada Lovelace","last_name": "Lovelace","first_name": "Ada","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "personal-name","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"phone_number_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "GB","phone_number": "+447234172834","attribute_type": "phone-number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"original_phone_number": "07234172834"}],"status_slug_example": [{"status": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "In Progress","is_archived": false,"celebration_enabled": false,"target_time_in_status": "P0Y0M1DT0H0M0S"},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "status","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"rating_slug_example": [{"value": 3,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "rating","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"select_slug_example": [{"option": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "Medium","is_archived": false},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "select","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"text_slug_example": [{"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "text","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"timestamp_slug_example": [{"value": "2020-06-02T23:58:40.347847393Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "timestamp","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
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.
If the matching attribute is a multiselect attribute, any newer values supplied will be created however any values removed 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.
object_configuration:readrequiredrecord_permission:read-writerequiredobjectstringREQUIRED
A UUID or slug to identify the Object the Record should belong to.
matching_attributestringREQUIRED
The ID or slug of the Attribute to use to check if a Record already exists. The Attribute must be unique.
dataobjectREQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/people/records?matching_attribute=41252299-f8c7-4b5e-99c9-4ff8321d2f96 \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-X PUT \-d @- << EOF{"data": {"values": {"41252299-f8c7-4b5e-99c9-4ff8321d2f96": [{"value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."}]}}}EOF
200 - Success
{"data": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"values": {"actor_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}],"checkbox_slug_example": [{"value": true,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "checkbox","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"currency_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","currency_code": "USD","attribute_type": "currency","currency_value": 99,"created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"date_slug_example": [{"value": "2022-11-21T13:22:49.061281000Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "date","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"domain_slug_example": [{"domain": "app.attio.com","active_from": "2022-11-21T13:22:49.061281000Z","root_domain": "attio.com","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "domain","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"email_address_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","email_domain": "app.attio.com","attribute_type": "email-address","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"email_root_domain": "attio.com","email_local_specifier": "alice",}],"record_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"}],"interaction_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","owner_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"active_until": "2022-11-21T13:22:49.061281000Z","interacted_at": "2023-06-09T20:31:13.326Z","attribute_type": "interaction","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"interaction_type": "email"}],"location_slug_example": [{"line_1": "1 Infinite Loop","line_2": "Block 1","line_3": "Hilldrop Estate","line_4": "Westborough","region": "CA","latitude": "37.331741","locality": "Cupertino","postcode": "95014","longitude": "-122.030333","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "US","attribute_type": "location","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"number_slug_example": [{"value": 42,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"personal_name_slug_example": [{"full_name": "Ada Lovelace","last_name": "Lovelace","first_name": "Ada","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "personal-name","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"phone_number_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "GB","phone_number": "+447234172834","attribute_type": "phone-number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"original_phone_number": "07234172834"}],"status_slug_example": [{"status": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "In Progress","is_archived": false,"celebration_enabled": false,"target_time_in_status": "P0Y0M1DT0H0M0S"},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "status","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"rating_slug_example": [{"value": 3,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "rating","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"select_slug_example": [{"option": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "Medium","is_archived": false},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "select","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"text_slug_example": [{"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "text","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"timestamp_slug_example": [{"value": "2020-06-02T23:58:40.347847393Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "timestamp","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Gets a single person, company or other Record by its record_id.
record_permission:readrequiredobject_configuration:readrequiredobjectstringREQUIRED
A UUID or slug identifying the Object the Record belongs to.
record_idstringREQUIRED
A UUID identifying the Record.
Format: UUID
Status code
Description
curl https://api.attio.com/v2/objects/people/records/bf071e1f-6035-429d-b874-d83ea64ea13b \-H "Authorization: Bearer <token>"
200 - Success
{"data": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"values": {"actor_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}],"checkbox_slug_example": [{"value": true,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "checkbox","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"currency_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","currency_code": "USD","attribute_type": "currency","currency_value": 99,"created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"date_slug_example": [{"value": "2022-11-21T13:22:49.061281000Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "date","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"domain_slug_example": [{"domain": "app.attio.com","active_from": "2022-11-21T13:22:49.061281000Z","root_domain": "attio.com","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "domain","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"email_address_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","email_domain": "app.attio.com","attribute_type": "email-address","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"email_root_domain": "attio.com","email_local_specifier": "alice",}],"record_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"}],"interaction_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","owner_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"active_until": "2022-11-21T13:22:49.061281000Z","interacted_at": "2023-06-09T20:31:13.326Z","attribute_type": "interaction","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"interaction_type": "email"}],"location_slug_example": [{"line_1": "1 Infinite Loop","line_2": "Block 1","line_3": "Hilldrop Estate","line_4": "Westborough","region": "CA","latitude": "37.331741","locality": "Cupertino","postcode": "95014","longitude": "-122.030333","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "US","attribute_type": "location","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"number_slug_example": [{"value": 42,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"personal_name_slug_example": [{"full_name": "Ada Lovelace","last_name": "Lovelace","first_name": "Ada","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "personal-name","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"phone_number_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "GB","phone_number": "+447234172834","attribute_type": "phone-number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"original_phone_number": "07234172834"}],"status_slug_example": [{"status": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "In Progress","is_archived": false,"celebration_enabled": false,"target_time_in_status": "P0Y0M1DT0H0M0S"},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "status","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"rating_slug_example": [{"value": 3,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "rating","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"select_slug_example": [{"option": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "Medium","is_archived": false},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "select","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"text_slug_example": [{"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "text","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"timestamp_slug_example": [{"value": "2020-06-02T23:58:40.347847393Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "timestamp","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
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 Assert endpoint to overwrite or remove multiselect Attribute Values. Please note, logo_url and avatar_url attributes cannot currently be updated via the API.
object_configuration:readrequiredrecord_permission:read-writerequiredobjectstringREQUIRED
A UUID or slug of the Object the Record belongs to.
record_idstringREQUIRED
A UUID of the Record to update.
dataobjectREQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/people/records/bf071e1f-6035-429d-b874-d83ea64ea13b \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-X PATCH \-d @- << EOF{"data": {"values": {"41252299-f8c7-4b5e-99c9-4ff8321d2f96": [{"value": "Powerful, flexible and data-driven, Attio makes it easy to build the exact CRM your business needs."}]}}}EOF
200 - Success
{"data": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"values": {"actor_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}],"checkbox_slug_example": [{"value": true,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "checkbox","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"currency_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","currency_code": "USD","attribute_type": "currency","currency_value": 99,"created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"date_slug_example": [{"value": "2022-11-21T13:22:49.061281000Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "date","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"domain_slug_example": [{"domain": "app.attio.com","active_from": "2022-11-21T13:22:49.061281000Z","root_domain": "attio.com","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "domain","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"email_address_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","email_domain": "app.attio.com","attribute_type": "email-address","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"email_root_domain": "attio.com","email_local_specifier": "alice",}],"record_reference_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"}],"interaction_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","owner_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"active_until": "2022-11-21T13:22:49.061281000Z","interacted_at": "2023-06-09T20:31:13.326Z","attribute_type": "interaction","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"interaction_type": "email"}],"location_slug_example": [{"line_1": "1 Infinite Loop","line_2": "Block 1","line_3": "Hilldrop Estate","line_4": "Westborough","region": "CA","latitude": "37.331741","locality": "Cupertino","postcode": "95014","longitude": "-122.030333","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "US","attribute_type": "location","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"number_slug_example": [{"value": 42,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"personal_name_slug_example": [{"full_name": "Ada Lovelace","last_name": "Lovelace","first_name": "Ada","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "personal-name","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"phone_number_slug_example": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","country_code": "GB","phone_number": "+447234172834","attribute_type": "phone-number","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"original_phone_number": "07234172834"}],"status_slug_example": [{"status": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","status_id": "11f07f01-c10f-4e05-a522-33e050bc52ee","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "In Progress","is_archived": false,"celebration_enabled": false,"target_time_in_status": "P0Y0M1DT0H0M0S"},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "status","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"rating_slug_example": [{"value": 3,"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "rating","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"select_slug_example": [{"option": {"id": {"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795","option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea","attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96","workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"},"title": "Medium","is_archived": false},"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "select","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"text_slug_example": [{"value": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "text","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}],"timestamp_slug_example": [{"value": "2020-06-02T23:58:40.347847393Z","active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "timestamp","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Deletes a single Record (e.g. a company or person) by ID.
object_configuration:readrequiredrecord_permission:read-writerequiredobjectstringREQUIRED
The UUID or slug of the Object the Record belongs to.
record_idstringREQUIRED
The UUID of the Record to delete.
Status code
Description
curl https://api.attio.com/v2/objects/people/records/bf071e1f-6035-429d-b874-d83ea64ea13b \-H "Authorization: Bearer <token>" \-X DELETE
200 - Success
{}
Gets all values for a given Attribute on a Record. If the Attribute is historic, this endpoint has the ability to return all historic values using the show_historic query param.
record_permission:readrequiredobject_configuration:readrequiredobjectstringREQUIRED
A UUID or slug to identify the Object the Record belongs to.
attributestringREQUIRED
A UUID or slug to identify the Attribute you want to query values on.
record_idstringREQUIRED
A UUID to identify the Record you want to query values on.
Format: UUID
limitintegerThe maximum number of results to return. See the full guide to pagination here.
offsetintegerThe number of results to skip over before returning. See the full guide to pagination here.
show_historicbooleanIf 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.
Status code
Description
curl https://api.attio.com/v2/objects/people/records/bf071e1f-6035-429d-b874-d83ea64ea13b/attributes/41252299-f8c7-4b5e-99c9-4ff8321d2f96/values?limit=10&offset=5&show_historic=true \-H "Authorization: Bearer <token>"
200 - Success
{"data": [{"active_from": "2022-11-21T13:22:49.061281000Z","active_until": "2022-11-21T13:22:49.061281000Z","attribute_type": "actor-reference","created_by_actor": {"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","type": "workspace-member"},"referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b","referenced_actor_type": "workspace-member"}]}
List all Entries, across all Lists, for which this Record is the parent.
list_entry:readrequiredrecord_permission:readrequiredobject_configuration:readrequiredobjectstringREQUIRED
A UUID or slug identifying the Object the Record belongs to.
record_idstringREQUIRED
A UUID identifying the Record.
Format: UUID
limitintegerThe maximum number of results to return. The default is 100 and the maximum is 1000. See the full guide to pagination here.
offsetintegerThe number of results to skip over before returning. The default is 0. See the full guide to pagination here.
Status code
Description
curl https://api.attio.com/v2/objects/people/records/bf071e1f-6035-429d-b874-d83ea64ea13b/entries?limit=10&offset=5 \-H "Authorization: Bearer <token>"
200 - Success
{"data": [{"list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0","entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156","created_at": "2022-11-21T13:22:49.061281000Z","list_api_slug": "hiring-engineering"}]}