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.
Lists Company Records, with the option to filter and sort results.
record_permission:read
requiredobject_configuration:read
requiredlimit
number
The maximum number of results to return. Defaults to 500 See the full guide to pagination here.
sorts
list
An 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.
filter
object
An object used to filter results to a subset of records. See the full guide to filtering and sorting here.
offset
number
The 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/companies/records/query \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-d @- << EOF{"limit": 10,"sorts": [{"field": "domain","attribute": "domains","direction": "asc"}],"filter": {"$and": [{"domains": {"domain": {"$eq": "attio.com"}}},{"description": {"value": {"$contains": "magic"}}}]},"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": {"name": [{"value": "Attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"team": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "121e50c2-65a3-449e-8397-c4d083d1e2e4"}],"domains": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"twitter": [{"value": "https://twitter.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"facebook": [{"value": "https://facebook.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"linkedin": [{"value": "https://linkedin.com/in/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"logo_url": [{"value": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/b792e7f9-003d-494f-a7b4-a53251c621e6","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"angellist": [{"value": "https://angellist.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"instagram": [{"value": "https://instagram.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"categories": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "B2B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"created_at": [{"value": "2022-07-11T11:51:47.182000000Z","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "timestamp","created_by_actor": {"id": null,"type": "system"}}],"created_by": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"description": [{"value": "Customer relationship magic","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"employee_range": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "gh65s5a9-94f3-410f-bb29-78287bc1c856","attribute_id": "8264c8c4-34b1-42b6-9e4c-4db8baa58d6b","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "51-250","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"foundation_date": [{"value": "2023-01-01","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "date","created_by_actor": {"id": null,"type": "system"}}],"last_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"primary_location": [{"line_1": null,"line_2": null,"line_3": null,"line_4": null,"region": null,"latitude": null,"locality": "London","postcode": null,"longitude": null,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","attribute_type": "location","created_by_actor": {"id": null,"type": "system"}}],"estimated_arr_usd": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "g73565a9-94f3-410f-bb29-78287bc1c715","attribute_id": "5678c8c4-34b1-42b6-9e4c-4db8baa58u7f","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "$500M-$1B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"twitter_follower_count": [{"value": 100,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}],"first_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"next_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_user": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"first_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_strength": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "Very strong","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"strongest_connection_strength_legacy": [{"value": 54.725113205693695,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}]}
Creates a new Company Record. This endpoint will throw on conflicts of unique Attributes, like domains
. If you would prefer to update Company Records on conflicts, please use the Assert Company Record endpoint instead. Please note, the logo_url
Attribute cannot currently be set via the API.
object_configuration:read
requiredrecord_permission:read-write
requireddata
object
REQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/companies/records \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-d @- << EOF{"data": {"values": {"name": [{"value": "Attio"}],"team": [{"target_object": "people","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"target_object": "people","email_addresses": [{}]}],"domains": [{"domain": "attio.com"}],"description": [{"value": "Customer relationship magic"}]}}}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": {"name": [{"value": "Attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"team": [],"domains": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"twitter": [],"facebook": [],"linkedin": [],"logo_url": [],"angellist": [],"instagram": [],"categories": [],"created_at": [{"value": "2023-01-01T15:00:00.000000000Z","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "timestamp","created_by_actor": {"id": null,"type": "system"}}],"created_by": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"description": [{"value": "Customer relationship magic","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"employee_range": [],"foundation_date": [],"last_interaction": [],"primary_location": [],"estimated_arr_usd": [],"first_interaction": [],"last_email_interaction": [],"twitter_follower_count": [],"first_email_interaction": [],"last_calendar_interaction": [],"next_calendar_interaction": [],"strongest_connection_user": [],"first_calendar_interaction": [],"strongest_connection_strength": [],"strongest_connection_strength_legacy": []},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Use this endpoint to create or update Company Records. A matching Attribute is used to search for existing Companies (for example the domains
Attribute). If a Company is found with the same value for the matching Attribute, that Company will be updated. If no Company with the same value for the matching Attribute is found, a new Company will be created instead. If you would like to avoid matching, please use the Create Company endpoint.
If the matching attribute is a multiselect attribute, 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:read
requiredrecord_permission:read-write
requiredmatching_attribute
string
REQUIRED
The ID or slug of the Attribute to use to check if a Company already exists. The Attribute must be unique. For Company Records domains
is the only unique Attribute, but you can add additional custom Attributes with unique constraints.
data
object
REQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/companies/records?matching_attribute=domains \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-X PUT \-d @- << EOF{"data": {"values": {"name": [{"value": "Attio"}],"team": [{"target_object": "people","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"target_object": "people","email_addresses": [{}]}],"domains": [{"domain": "attio.com"}],"description": [{"value": "Customer relationship magic"}]}}}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": {"name": [{"value": "Attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"team": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "121e50c2-65a3-449e-8397-c4d083d1e2e4"}],"domains": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"twitter": [{"value": "https://twitter.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"facebook": [{"value": "https://facebook.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"linkedin": [{"value": "https://linkedin.com/in/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"logo_url": [{"value": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/b792e7f9-003d-494f-a7b4-a53251c621e6","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"angellist": [{"value": "https://angellist.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"instagram": [{"value": "https://instagram.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"categories": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "B2B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"created_at": [{"value": "2022-07-11T11:51:47.182000000Z","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "timestamp","created_by_actor": {"id": null,"type": "system"}}],"created_by": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"description": [{"value": "Customer relationship magic","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"employee_range": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "gh65s5a9-94f3-410f-bb29-78287bc1c856","attribute_id": "8264c8c4-34b1-42b6-9e4c-4db8baa58d6b","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "51-250","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"foundation_date": [{"value": "2023-01-01","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "date","created_by_actor": {"id": null,"type": "system"}}],"last_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"primary_location": [{"line_1": null,"line_2": null,"line_3": null,"line_4": null,"region": null,"latitude": null,"locality": "London","postcode": null,"longitude": null,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","attribute_type": "location","created_by_actor": {"id": null,"type": "system"}}],"estimated_arr_usd": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "g73565a9-94f3-410f-bb29-78287bc1c715","attribute_id": "5678c8c4-34b1-42b6-9e4c-4db8baa58u7f","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "$500M-$1B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"twitter_follower_count": [{"value": 100,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}],"first_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"next_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_user": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"first_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_strength": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "Very strong","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"strongest_connection_strength_legacy": [{"value": 54.725113205693695,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Gets a single Company Record by its record_id
.
record_permission:read
requiredobject_configuration:read
requiredrecord_id
string
REQUIRED
A UUID of the Company Record to fetch.
Status code
Description
curl https://api.attio.com/v2/objects/companies/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": {"name": [{"value": "Attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"team": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "121e50c2-65a3-449e-8397-c4d083d1e2e4"}],"domains": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"twitter": [{"value": "https://twitter.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"facebook": [{"value": "https://facebook.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"linkedin": [{"value": "https://linkedin.com/in/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"logo_url": [{"value": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/b792e7f9-003d-494f-a7b4-a53251c621e6","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"angellist": [{"value": "https://angellist.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"instagram": [{"value": "https://instagram.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"categories": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "B2B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"created_at": [{"value": "2022-07-11T11:51:47.182000000Z","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "timestamp","created_by_actor": {"id": null,"type": "system"}}],"created_by": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"description": [{"value": "Customer relationship magic","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"employee_range": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "gh65s5a9-94f3-410f-bb29-78287bc1c856","attribute_id": "8264c8c4-34b1-42b6-9e4c-4db8baa58d6b","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "51-250","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"foundation_date": [{"value": "2023-01-01","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "date","created_by_actor": {"id": null,"type": "system"}}],"last_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"primary_location": [{"line_1": null,"line_2": null,"line_3": null,"line_4": null,"region": null,"latitude": null,"locality": "London","postcode": null,"longitude": null,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","attribute_type": "location","created_by_actor": {"id": null,"type": "system"}}],"estimated_arr_usd": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "g73565a9-94f3-410f-bb29-78287bc1c715","attribute_id": "5678c8c4-34b1-42b6-9e4c-4db8baa58u7f","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "$500M-$1B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"twitter_follower_count": [{"value": 100,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}],"first_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"next_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_user": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"first_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_strength": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "Very strong","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"strongest_connection_strength_legacy": [{"value": 54.725113205693695,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Use this endpoint to update Company Records by record_id
. If the update payload includes multiselect Attributes, the values supplied will be created and prepended to the list of values that already exist (if any). Use the PUT
Assert Company endpoint to overwrite or remove multiselect Attribute Values. Please note, the logo_url
Attribute cannot currently be updated via the API.
object_configuration:read
requiredrecord_permission:read-write
requiredrecord_id
string
REQUIRED
A UUID of the Company Record to update.
data
object
REQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/companies/records/bf071e1f-6035-429d-b874-d83ea64ea13b \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-X PATCH \-d @- << EOF{"data": {"values": {"name": [{"value": "Attio"}],"team": [{"target_object": "people","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"target_object": "people","email_addresses": [{}]}],"domains": [{"domain": "attio.com"}],"description": [{"value": "Customer relationship magic"}]}}}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": {"name": [{"value": "Attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"team": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "people","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "121e50c2-65a3-449e-8397-c4d083d1e2e4"}],"domains": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"twitter": [{"value": "https://twitter.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"facebook": [{"value": "https://facebook.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"linkedin": [{"value": "https://linkedin.com/in/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"logo_url": [{"value": "https://d1ts43dypk8bqh.cloudfront.net/v1/avatars/b792e7f9-003d-494f-a7b4-a53251c621e6","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"angellist": [{"value": "https://angellist.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"instagram": [{"value": "https://instagram.com/attio","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"categories": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "B2B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"created_at": [{"value": "2022-07-11T11:51:47.182000000Z","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "timestamp","created_by_actor": {"id": null,"type": "system"}}],"created_by": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"description": [{"value": "Customer relationship magic","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"employee_range": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "gh65s5a9-94f3-410f-bb29-78287bc1c856","attribute_id": "8264c8c4-34b1-42b6-9e4c-4db8baa58d6b","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "51-250","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"foundation_date": [{"value": "2023-01-01","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "date","created_by_actor": {"id": null,"type": "system"}}],"last_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"primary_location": [{"line_1": null,"line_2": null,"line_3": null,"line_4": null,"region": null,"latitude": null,"locality": "London","postcode": null,"longitude": null,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","attribute_type": "location","created_by_actor": {"id": null,"type": "system"}}],"estimated_arr_usd": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "g73565a9-94f3-410f-bb29-78287bc1c715","attribute_id": "5678c8c4-34b1-42b6-9e4c-4db8baa58u7f","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "$500M-$1B","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"twitter_follower_count": [{"value": 100,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}],"first_email_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"last_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"next_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_user": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "actor-reference","created_by_actor": {"id": null,"type": "system"},"referenced_actor_id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","referenced_actor_type": "workspace-member"}],"first_calendar_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"active_until": null,"interacted_at": "2023-01-01T15:00:00.000000000Z","attribute_type": "interaction","created_by_actor": {"id": null,"type": "system"},"interaction_type": "email"}],"strongest_connection_strength": [{"option": {"id": {"object_id": "cf49cf53-dbb4-4d18-87fc-28aba21d7a49","option_id": "e37175a9-94f3-410f-bb29-78287bc1c444","attribute_id": "7914c8c4-34b1-42b6-9e4c-4db8baa58bfa","workspace_id": "ca10906c-6785-464e-bb6c-b003e63c6a18"},"title": "Very strong","is_archived": false},"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "select","created_by_actor": {"id": null,"type": "system"}}],"strongest_connection_strength_legacy": [{"value": 54.725113205693695,"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "number","created_by_actor": {"id": null,"type": "system"}}]},"created_at": "2022-11-21T13:22:49.061281000Z"}}
Deletes a single Company Record by ID.
object_configuration:read
requiredrecord_permission:read-write
requiredrecord_id
string
REQUIRED
The UUID of the Company Record to delete.
Status code
Description
curl https://api.attio.com/v2/objects/companies/records/bf071e1f-6035-429d-b874-d83ea64ea13b \-H "Authorization: Bearer <token>" \-X DELETE
200 - Success
{}
Gets all values for a given Attribute on a Company Record. If the Attribute is historic, this endpoint has the ability to return all historic values using the show_historic
query param.
record_permission:read
requiredobject_configuration:read
requiredattribute
string
REQUIRED
A UUID or slug to identify the Attribute you want to query values on.
record_id
string
REQUIRED
A UUID of the Company Record to fetch.
limit
integer
The maximum number of results to return. See the full guide to pagination here.
offset
integer
The number of results to skip over before returning. See the full guide to pagination here.
show_historic
boolean
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.
Status code
Description
curl https://api.attio.com/v2/objects/companies/records/bf071e1f-6035-429d-b874-d83ea64ea13b/attributes/domains/values?limit=10&offset=5&show_historic=true \-H "Authorization: Bearer <token>"
200 - Success
{"data": [{"domain": "attio.com","active_from": "2023-01-01T15:00:00.000000000Z","root_domain": "attio.com","active_until": null,"attribute_type": "domain","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}]}
List all Entries, across all Lists, for which this Company Record is the parent.
list_entry:read
requiredrecord_permission:read
requiredobject_configuration:read
requiredrecord_id
string
REQUIRED
A UUID of the Company Record to fetch.
limit
integer
The maximum number of results to return. The default is 100
and the maximum is 1000
. See the full guide to pagination here.
offset
integer
The 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/companies/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": "sales-prospects"}]}