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.
Use this endpoint to update Person 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 Person endpoint to overwrite or remove multiselect Attribute Values. Please note, the avatar_url Attribute cannot currently be updated via the API.
object_configuration:readrequiredrecord_permission:read-writerequiredrecord_idstringREQUIRED
A UUID of the Person 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": {"name": [{"full_name": "John Smith","last_name": "Smith","first_name": "John"}],"company": [{"target_object": "companies","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"domains": [{"domain": "attio.com"}],"target_object": "companies"}],"description": [{"value": "Developer met at event"}],"email_addresses": [{}]}}}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": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"company": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "companies","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "f528bd86-8142-4359-9a8c-b651d50a27b1"}],"twitter": [{"value": "https://twitter.com/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"job_title": [{"value": "Software Engineer","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"avatar_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"}}],"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": "Developer met at event","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"}}],"phone_numbers": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","phone_number": "+447123456789","attribute_type": "phone-number","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"original_phone_number": "+447123456789"}],"email_addresses": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"email_domain": "attio.com","attribute_type": "email-address","created_by_actor": {"id": null,"type": "system"},"email_root_domain": "attio.com","email_local_specifier": "john-smith",}],"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"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "system"},"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": "system"},"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 Person Record by ID.
object_configuration:readrequiredrecord_permission:read-writerequiredrecord_idstringREQUIRED
The UUID of the Person 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 Person 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:readrequiredattributestringREQUIRED
A UUID or slug to identify the Attribute you want to query values on.
record_idstringREQUIRED
A UUID of the Person Record to fetch.
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/name/values?limit=10&offset=5&show_historic=true \-H "Authorization: Bearer <token>"
200 - Success
{"data": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}]}
List all Entries, across all Lists, for which this Person Record is the parent.
list_entry:readrequiredrecord_permission:readrequiredobject_configuration:readrequiredrecord_idstringREQUIRED
A UUID of the Person Record to fetch.
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"}]}
Lists Person Records, with the option to filter and sort results.
record_permission:readrequiredobject_configuration:readrequiredlimitnumberThe 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": {"$and": [{"name": {"last_name": {"$eq": "Smith"},"first_name": {"$eq": "John"}}},{"description": {"value": {"$contains": "event"}}}]},"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": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"company": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "companies","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "f528bd86-8142-4359-9a8c-b651d50a27b1"}],"twitter": [{"value": "https://twitter.com/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"job_title": [{"value": "Software Engineer","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"avatar_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"}}],"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": "Developer met at event","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"}}],"phone_numbers": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","phone_number": "+447123456789","attribute_type": "phone-number","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"original_phone_number": "+447123456789"}],"email_addresses": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"email_domain": "attio.com","attribute_type": "email-address","created_by_actor": {"id": null,"type": "system"},"email_root_domain": "attio.com","email_local_specifier": "john-smith",}],"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"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "system"},"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": "system"},"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 Person Record. This endpoint will throw on conflicts of unique Attributes, like email_addresses. If you would prefer to update Person Records on conflicts, please use the Assert Person Record endpoint instead. Please note, the avatar_url Attribute cannot currently be set via the API.
object_configuration:readrequiredrecord_permission:read-writerequireddataobjectREQUIRED
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": {"name": [{"full_name": "John Smith","last_name": "Smith","first_name": "John"}],"company": [{"target_object": "companies","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"domains": [{"domain": "attio.com"}],"target_object": "companies"}],"description": [{"value": "Developer met at event"}],"email_addresses": [{}]}}}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": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"company": [],"twitter": [],"facebook": [],"linkedin": [],"angellist": [],"instagram": [],"job_title": [],"avatar_url": [],"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": "Developer met at event","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"}}],"phone_numbers": [],"email_addresses": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"email_domain": "attio.com","attribute_type": "email-address","created_by_actor": {"id": null,"type": "system"},"email_root_domain": "attio.com","email_local_specifier": "john-smith",}],"last_interaction": [],"primary_location": [],"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 Person Records. A matching Attribute is used to search for existing People (for example the email_addresses Attribute). If a Person is found with the same value for the matching Attribute, that Person will be updated. If no Person with the same value for the matching Attribute is found, a new Person will be created instead. If you would like to avoid matching, please use the Create Person 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-writerequiredmatching_attributestringREQUIRED
The ID or slug of the Attribute to use to check if a Person already exists. The Attribute must be unique. For Person Records email_addresses is the only unique Attribute, but you can add additional custom Attributes with unique constraints.
dataobjectREQUIRED
Status code
Description
curl https://api.attio.com/v2/objects/people/records?matching_attribute=email_addresses \-H "Authorization: Bearer <token>" \-H "Content-Type: application/json" \-X PUT \-d @- << EOF{"data": {"values": {"name": [{"full_name": "John Smith","last_name": "Smith","first_name": "John"}],"company": [{"target_object": "companies","target_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"},{"domains": [{"domain": "attio.com"}],"target_object": "companies"}],"description": [{"value": "Developer met at event"}],"email_addresses": [{}]}}}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": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"company": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "companies","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "f528bd86-8142-4359-9a8c-b651d50a27b1"}],"twitter": [{"value": "https://twitter.com/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"job_title": [{"value": "Software Engineer","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"avatar_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"}}],"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": "Developer met at event","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"}}],"phone_numbers": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","phone_number": "+447123456789","attribute_type": "phone-number","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"original_phone_number": "+447123456789"}],"email_addresses": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"email_domain": "attio.com","attribute_type": "email-address","created_by_actor": {"id": null,"type": "system"},"email_root_domain": "attio.com","email_local_specifier": "john-smith",}],"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"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "system"},"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": "system"},"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 Person Record by its record_id.
record_permission:readrequiredobject_configuration:readrequiredrecord_idstringREQUIRED
A UUID of the Person Record to fetch.
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": {"name": [{"full_name": "John Smith","last_name": "Smith","first_name": "John","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "personal-name","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"}}],"company": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"target_object": "companies","attribute_type": "record-reference","created_by_actor": {"id": null,"type": "system"},"target_record_id": "f528bd86-8142-4359-9a8c-b651d50a27b1"}],"twitter": [{"value": "https://twitter.com/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","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/johnsmith","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"job_title": [{"value": "Software Engineer","active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"attribute_type": "text","created_by_actor": {"id": null,"type": "system"}}],"avatar_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"}}],"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": "Developer met at event","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"}}],"phone_numbers": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"country_code": "GB","phone_number": "+447123456789","attribute_type": "phone-number","created_by_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "workspace-member"},"original_phone_number": "+447123456789"}],"email_addresses": [{"active_from": "2023-01-01T15:00:00.000000000Z","active_until": null,"email_domain": "attio.com","attribute_type": "email-address","created_by_actor": {"id": null,"type": "system"},"email_root_domain": "attio.com","email_local_specifier": "john-smith",}],"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"}}],"first_interaction": [{"active_from": "2023-01-01T15:00:00.000000000Z","owner_actor": {"id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64","type": "system"},"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": "system"},"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"}}