Retrieve Customers
Retrieve customers from any connected Ats software
Path parameters
id of the customer you want to retrieve.
Query parameters
Set to true to include data from the original Ats software.
Headers
The connection token
Response
Example response
{
"email": "joedoe@gmail.com",
"first_name": "Joe",
"last_name": "Doe",
"phone_number": "+336666666",
"addresses": [
{
"address_type": "PERSONAL",
"street_1": "5th Avenue",
"state": "New York",
"city": "New York",
"country": "United States of America"
}
],
"field_mappings": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
"remote_id": "id_1",
"remote_data": {
"fav_dish": "broccoli",
"fav_color": "red"
},
"created_at": "2024-10-01T12:00:00Z",
"modified_at": "2024-10-01T12:00:00Z"
}Changes
Changed in 3 of the 18 revisions of this API.1111
- ○
removed the
PERSONALenum value from the//response property for the response statusresponse-property-enum-value-removed
- ○
removed the
WORKenum value from the//response property for the response statusresponse-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ▲
the response property
became nullable for the statusresponse-property-became-nullable
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ○
added the required property
//to the response with the statusresponse-required-property-added
- ▲
- ○
endpoint added
endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○