Sign in
ats/candidates

Retrieve Candidates

Retrieve Candidates from any connected Ats software

get/ats/candidates/{id}

Path parameters

idstring required

id of the candidate you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original Ats software.

Headers

x-connection-tokenstring required

The connection token

Response

first_namestring nullable

The first name of the candidate

last_namestring nullable

The last name of the candidate

companystring nullable

The company of the candidate

titlestring nullable

The title of the candidate

locationsstring nullable

The locations of the candidate

is_privateboolean nullable

Whether the candidate is private

email_reachableboolean nullable

Whether the candidate is reachable by email

remote_created_atstring date-time nullable

The remote creation date of the candidate

remote_modified_atstring date-time nullable

The remote modification date of the candidate

last_interaction_atstring date-time nullable

The last interaction date with the candidate

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the candidate

remote_idstring nullable

The id of the candidate in the context of the 3rd Party

remote_dataobject nullable

The remote data of the candidate in the context of the 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "first_name": "Joe",
  "last_name": "Doe",
  "company": "Acme",
  "title": "Analyst",
  "locations": "New York",
  "email_reachable": true,
  "remote_created_at": "2024-10-01T12:00:00Z",
  "remote_modified_at": "2024-10-01T12:00:00Z",
  "last_interaction_at": "2024-10-01T12:00:00Z",
  "attachments": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "applications": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "tags": [
    "tag_1",
    "tag_2"
  ],
  "urls": [
    {
      "url": "mywebsite.com",
      "url_type": "WEBSITE"
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+33660688899",
      "phone_type": "WORK"
    }
  ],
  "email_addresses": [
    {
      "email_address": "joedoe@gmail.com",
      "email_address_type": "WORK"
    }
  ],
  "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