ats
candidate

List all candidates

Changed on

Returns a list of AtsCandidates. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/ats/{connection_id}/candidate

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/ats/{connection_id}/candidate
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

company_idstring

The company ID to filter by (reference to AtsCompany)

job_idstring

The job ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The candidate's full name

first_namestring
last_namestring
titlestring

Candidate’s current job title

company_namestring

Name of company where candidate currently works

image_urlstring
tagsstring[]
external_identifierstring
link_urlsstring[]

URLs for web pages containing additional material about the candidate (LinkedIn, other social media, articles, etc.)

origin'AGENCY' | 'APPLIED' | 'INTERNAL' | 'REFERRED' | 'SOURCED' | 'UNIVERSITY'
company_idstring

(reference to AtsCompany)

sourcesstring[]
date_of_birthstring date-time
user_idstring

Employee ID that owns the relationship for this candidate (reference to HrisEmployee)

user_idsstring[]

references hris employees

web_urlstring
skillsstring[]
job_idsstring[]
summarystring

Personal / professional bio

rawobject

Changes