--- title: "List Candidates" method: GET path: "/ats/candidates" tags: ["ats/candidates"] --- # List Candidates `GET /ats/candidates` ## Query parameters - `remote_data` boolean - `limit` number - `cursor` string ## Headers - `x-connection-token` string, required ## Response `200` - object - `prev_cursor` string, nullable, required - `next_cursor` string, nullable, required - `data` object[], required - `first_name` string, nullable — The first name of the candidate - `last_name` string, nullable — The last name of the candidate - `company` string, nullable — The company of the candidate - `title` string, nullable — The title of the candidate - `locations` string, nullable — The locations of the candidate - `is_private` boolean, nullable — Whether the candidate is private - `email_reachable` boolean, nullable — Whether the candidate is reachable by email - `remote_created_at` string, date-time, nullable — The remote creation date of the candidate - `remote_modified_at` string, date-time, nullable — The remote modification date of the candidate - `last_interaction_at` string, date-time, nullable — The last interaction date with the candidate - `attachments` union[], nullable — The attachments UUIDs of the candidate - union - string - UnifiedAtsAttachmentOutput - `file_url` string, nullable — The URL of the file - `file_name` string, nullable — The name of the file - `attachment_type` string, nullable — The type of the file - `remote_created_at` string, date-time, nullable — The remote creation date of the attachment - `remote_modified_at` string, date-time, nullable — The remote modification date of the attachment - `candidate_id` string, nullable — The UUID of the candidate - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora - `id` string, nullable — The UUID of the attachment - `remote_id` string, nullable — The remote ID of the attachment - `remote_data` object, nullable — The remote data of the attachment in the context of the 3rd Party - `created_at` string, date-time, nullable — The created date of the object - `modified_at` string, date-time, nullable — The modified date of the object - `applications` union[], nullable — The applications UUIDs of the candidate - union - string - UnifiedAtsApplicationOutput - `applied_at` string, date-time, nullable — The application date - `rejected_at` string, date-time, nullable — The rejection date - `offers` string[], nullable — The offers UUIDs for the application - `source` string, nullable — The source of the application - `credited_to` string, nullable — The UUID of the person credited for the application - `current_stage` string, nullable — The UUID of the current stage of the application - `reject_reason` string, nullable — The rejection reason for the application - `candidate_id` string, nullable — The UUID of the candidate - `job_id` string — The UUID of the job - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora - `id` string, nullable — The UUID of the application - `remote_id` string, nullable — The remote ID of the application in the context of the 3rd Party - `remote_data` object, nullable — The remote data of the application in the context of the 3rd Party - `created_at` string, date-time, nullable — The created date of the object - `modified_at` string, date-time, nullable — The modified date of the object - `remote_created_at` string, date-time, nullable — The remote created date of the object - `remote_modified_at` string, date-time, nullable — The remote modified date of the object - `tags` union[], nullable — The tags of the candidate - union - string - UnifiedAtsTagOutput - `name` string, nullable — The name of the tag - `id_ats_candidate` string, nullable — The UUID of the candidate - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora - `id` string, nullable — The UUID of the tag - `remote_id` string, nullable — The remote ID of the tag in the context of the 3rd Party - `remote_data` object, nullable — The remote data of the tag in the context of the 3rd Party - `created_at` string, date-time, nullable — The creation date of the tag - `modified_at` string, date-time, nullable — The modification date of the tag - `urls` Url[], nullable — The urls of the candidate, possible values for Url type are WEBSITE, BLOG, LINKEDIN, GITHUB, or OTHER - `url` string, nullable, required — The url. - `url_type` string, nullable, required — The url type. It takes [WEBSITE | BLOG | LINKEDIN | GITHUB | OTHER] - `phone_numbers` Phone[], nullable — The phone numbers of the candidate - `phone_number` string, nullable, required — The phone number starting with a plus (+) followed by the country code (e.g +336676778890 for France) - `phone_type` string, nullable, required — The phone type. Authorized values are either MOBILE or WORK - `owner_type` string, nullable — The owner type of a phone number - `email_addresses` Email[], nullable — The email addresses of the candidate - `email_address` string, nullable, required — The email address - `email_address_type` string, nullable, required — The email address type. Authorized values are either PERSONAL or WORK. - `owner_type` 'COMPANY' | 'CONTACT', nullable — The owner type of an email - `field_mappings` object, nullable — The custom field mappings of the object between the remote 3rd party & Panora - `id` string, nullable — The UUID of the candidate - `remote_id` string, nullable — The id of the candidate in the context of the 3rd Party - `remote_data` object, nullable — The remote data of the candidate in the context of the 3rd Party - `created_at` string, date-time, nullable — The created date of the object - `modified_at` string, date-time, nullable — The modified date of the object ## Changes - **2024-09-05** `5ba5c769e2e1` — 1 breaking - for the `query` request parameter `limit`, default value `50` was added - **2024-09-03** `8f398d57935f` — 1 breaking - for the `query` request parameter `limit`, default value `50` was removed - **2024-08-27** `5ba5c769e2e1` — 8 info - removed the `COVER_LETTER` enum value from the `allOf[subschema #2]/data/items/attachments/items/oneOf[#/components/schemas/UnifiedAtsAttachmentOutput]/attachment_type` response property for the response status `200` - removed the `MOBILE` enum value from the `allOf[subschema #2]/data/items/phone_numbers/items/phone_type` response property for the response status `200` - removed the `OFFER_LETTER` enum value from the `allOf[subschema #2]/data/items/attachments/items/oneOf[#/components/schemas/UnifiedAtsAttachmentOutput]/attachment_type` response property for the response status `200` - removed the `OTHER` enum value from the `allOf[subschema #2]/data/items/attachments/items/oneOf[#/components/schemas/UnifiedAtsAttachmentOutput]/attachment_type` response property for the response status `200` - …4 more - **2024-08-09** `c3d85dda63e0` — 1 breaking - for the `query` request parameter `limit`, default value `50` was added - **2024-08-08** `d33d911413f7` — 1 breaking - for the `query` request parameter `limit`, default value `30` was removed [Full history](https://skmtc.dev/panoratech/apis/panora-api/changes/ats/candidates/get.md) --- [API](https://skmtc.dev/panoratech/apis/panora-api.md) · [All operations](https://skmtc.dev/panoratech/apis/panora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/panoratech/apis/panora-api/revisions/634ca9b624aa?raw)