ats
candidate

Retrieve a candidate

Changed on
get/ats/{connection_id}/candidate/{id}

Request

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

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Candidate

Query parameters

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

rawobject

Changes

  • fbf77d34910fRevision changes
    • info

      added the enum value summary to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 8f2437668567Revision changes
    • info

      added the enum value user_ids to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status