ats
candidate

List all candidates

get/ats/{connection_id}/candidate

Request

  • Base URL: http://api.unified.to
  • URL: http://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 date-time

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

sort'name' | 'updated_at' | 'created_at'
order'asc' | 'desc'
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
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

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.