API Reference
Signup For Free

Application Data Models

📘

Use data type ats_applicationsin the Sync APIs to get these models

Here are the different models you can subscribe to while doing a sync

Model IDEvent Data KeyDescription
application_infoinfoGet the data of an application like applicant details, job id, appliedAt, owner, creditedTo etc
application_stagecurrentStageGet information about the application's current stage
application_interviewsinterviewsGet information about all the interviews associated with an application like id, subject, scheduledStart, scheduledEnd, status, interviewers etc
application_rejectionrejectionGet information about an application's rejection like id, reason etc
application_offersoffersGet the offers associated with an application
application_attachmentsattachmentsGet the attachments associated with an application

All these models have been detailed out below for your reference.

📘

Use Model IDs for Sync

While invoking sync APIs, pass these model IDs in order to get the desired data.

User

NameTypeDescription
idStringUser ID in the ATS system
emailString
employeeIdStringEmployee ID of the user

Application Info

Model ID: application_info

NameTypeDescription
idStringApplication ID
statusEnumOne of
ACTIVE
REJECTED
HIRED
NOT_SPECIFIED
candidateCandidateCandidate Details
originEnumOne of
AGENCY,
REFERRAL,
EXTERNAL
NOT_SPECIFIED
appliedAtDate
updatedAtDate
jobIdStringJob ID of the application. More info about the Job data model can be found here
ownerUserOwner of the application in the ATS system
creditedToUserThe user who will receive credit for this application

Candidate

NameTypeDescription
idStringCandidate ID
firstNameString
lastNameString
phonesPhone
emailsList[Email]
linksList[String]Links associated with the candidate like LinkedIn, Website etc
locationString

Phone

NameTypeDescription
typeEnumOne of
WORK,
PERSONAL,
SKYPE
NOT_SPECIFIED
phoneNumberString

Email

NameTypeDescription
typeEnumOne of
WORK,
PERSONAL,
NOT_SPECIFIED
emailString

Application Stage

Model ID: application_stage

NameTypeDescription
currentStageStage

Stage

NameTypeDescription
idStringStage Id
textStringStage Name

Application Interviews

Model ID: application_interviews

NameTypeDescription
interviewsList[Interview]

Interview

NameTypeDescription
idStringInterview Id
subjectString
createdAtDate
scheduledStartDate
scheduledEndDate
stageStageStage the application was in when this interview was scheduled
interviewersList[User]
locationString
creatorUser
statusEnumOne of
SCHEDULED
AWAITING_FEEDBACK
COMPLETE
CANCELLED
NOT_SPECIFIED

Application Rejection

Model ID: application_rejection

NameTypeDescription
idString
textString
rejectedAtDate

Application Offers

Model ID: application_offers

NameTypeDescription
offersList[Offer]

Offer

NameTypeDescription
idString
statusEnumOne of
IN_PROGRESS
SIGNED
DENIED
DEPRECATED
NOT_SPECIFIED
createdAtDate
sentAtDate
closedAtDate

Application Attachments

Model ID: application_attachments

NameTypeDescription
attachmentsList[Attachment]

Attachment

NameTypeDescription
typeEnumOne of
RESUME
COVER_LETTER
OFFER_LETTER
NOT_SPECIFIED
nameStringFile Name
linkStringDownloadable link of the file. (Caution: Some ATS systems might only provide a short lived link)
attachmentContentAttachmentContentContent of the attachment
createdAtDateWhen this attachment was created

Attachment Content

NameTypeDescription
contentString
encodingEnumOne of
BASE64
NOT_SPECIFIED

Event Data Example

{
  "info": {
    "id": "lRQ03MnbWBSTKHX",
    "status": "ACTIVE",
    "candidate": {
      "id": "X73cKg1NAFUJTec",
      "firstName": "ABC",
      "lastName": "DEF",
      "phones": [
        {
          "type": "PERSONAL",
          "phoneNumber": "000-000-00"
        },
        {
          "type": "WORK",
          "phoneNumber": "000-000-00
        },
      ],
      "emails": [
        {
          "type": "PERSONAL",
          "email": "[email protected]"
        }
      ],
      "links": [
        "www.blog.com",
        "www.linkedin.com/abc
      ],
      "location": "Delhi, India"
    },
    "origin": "EXTERNAL",
    "appliedAt": "1970-01-01T00:00:00Z",
    "updatedAt": "1970-01-01T00:00:00Z",
    "jobId": "Ty60CurNfqp5I9r",
    "owner": {
      "id": "tDWso22iFg8iN56",
      "email": "[email protected]",
      "employeeId": "re8AKBnyujPZ4Yb"
    },
    "creditedTo": {
      "id": "UxXF6C3PwZ4gD4c",
      "email": "[email protected]",
      "employeeId": "ChdsLhmoelplUGN"
    }
  },
  "currentStage": {
    "id": "JLUnI5TFKWbhQ1k",
    "text": "Technical Test"
  },
  "interviews": [
    {
      "id": "uKt2wVW0iSsmw8p",
      "subject": "Tehnical Screen",
      "createdAt": "1970-01-01T00:00:00Z",
      "scheduledStart": "1970-01-01T00:00:00Z",
      "scheduledEnd": "1970-01-01T00:00:00Z",
      "stage": {
        "id": "T63bQ43io2vlgSQ",
        "text": "Interview"
      },
      "interviewers": [
        {
          "id": "PrJjg0mYYSkucbC",
          "email": "[email protected]",
          "employeeId": "WvDRi2Hw9wBOGpp"
        },
        {
          "id": "LjwEnf8vBXMCa1q",
          "email": "[email protected]",
          "employeeId": "HYajD4pt5NNKPto"
        },
        {
          "id": "uf6XtHjVqoJATnD",
          "email": "[email protected]",
          "employeeId": "97XBkbEiDZhlpg4"
        }
      ],
      "location": "zoom.com/interview",
      "creator": {
        "id": "7hHbRoqaZrUWKsE",
        "email": "[email protected]",
        "employeeId": "FCaMvYS2i6z7Idp"
      },
      "status": "COMPLETED"
    }
  ],
  "rejection": {
    "id": "xw0QKdLFrxFh70E",
    "text": "Did not meet our standards",
    "rejectedAt": "1970-01-01T00:00:00Z"
  },
  "offers": [
    {
      "id": "cGCo5ALjUDpjdmZ",
      "status": "SIGNED",
      "createdAt": "1970-01-01T00:00:00Z",
      "sentAt": "1970-01-01T00:00:00Z",
      "closedAt": "1970-01-01T00:00:00Z"
    },
    {
      "id": "mkQKiEvrYDgCtaA",
      "status": "DENIED",
      "createdAt": "1970-01-01T00:00:00Z",
      "sentAt": "1970-01-01T00:00:00Z",
      "closedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "attachments": [
    {
      "type": "OFFER_LETTER",
      "name": "Offer 1",
      "link": "abc.com/offer1",
      "createdAt": "1970-01-01T00:00:00Z"
    },
    {
      "type": "COVER_LETTER",
      "name": "Cover Letter",
      "attachmentContent": {
        "content" : "b29fTVJrRWU5dW1CU2NQNUlTYkFkc3dJdTpzbGFjaw==",
        "encoding" : "BASE64"
      },
      "createdAt": "1970-01-01T00:00:00Z"
    }
  ]
}