ats
document

List all documents

Changed on
get/ats/{connection_id}/document

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ats/{connection_id}/document
  • 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

application_idstring

The application ID to filter by

candidate_idstring

The candidate ID to filter by

job_idstring

The job ID to filter by

typestring
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)

document_urlstring

This link expires after 1 hour.

document_datastring

base64 encoded file contents used for create/update actions. Use this field to send an attachment e.g. a resume, a profile, or other text content

filenamestring
type'RESUME' | 'COVER_LETTER' | 'OFFER_PACKET' | 'OFFER_LETTER' | 'TAKE_HOME_TEST' | 'OTHER'
candidate_idstring
application_idstring
job_idstring
user_idstring

(reference to HrisEmployee)

rawobject

Changes

  • 39502239a975Revision changes
    • info

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

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status