Job Data Models

📘

Use data type ats_jobsin the Sync APIs to get these models

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

Model IDEvent Data KeyDescription
job_infoinfoGet the data of a job like id, title, createdAt, status, url etc
job_departmentsdepartmentsGet information about departments which the job belongs to
job_officesofficesGet information about the offices which the job belongs to
job_hiringManagershiringManagersGet information about the hiring managers of the job
job_recruitersrecruitersGet the recruiters associated with the job
job_stagesstagesGet information about all the stages associated with the job
job_rawValuesrawValuesGet information raw values of status, descriptions associated with job.

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

Job Info

Model ID: job_info

NameTypeDescription
idStringJob ID
titleString
descriptionString
createdAtDate
updatedAtDate
closedAtDate
statusEnumOne of
OPEN,
CLOSED
DRAFT
NOT_SPECIFIED
isConfidentialBooleanIndicates whether the job is confidential
jobCodesList[String]Typically an additional identifier used to reference the job provided by the organization posting the job.
infoUrlStringURL that points to the job's information page
applyUrlStringURL that points to the job's apply page

Job Departments

Model ID: job_departments

NameTypeDescription
departmentsList[Department]Departments associated with the job

Department

NameTypeDescription
idStringID provided by the ATS
nameString

Job Offices

Model ID: job_offices

NameTypeDescription
officesList[Office]Offices associated with the job

Office

NameTypeDescription
idStringID provided by the ATS
nameString
locationString
addressAddressPlease refer to https://developers.getknit.dev/reference/base-models#address

Job Hiring Managers

Model ID: job_hiringManagers

NameTypeDescription
hiringManagersList[User]Hiring Managers associated with the job

Job Recruiters

Model ID: job_recruiters

NameTypeDescription
recruitersList[User]Recruiters associated with the job

Job Stages

Model ID: job_stages

NameTypeDescription
stagesList[Stage]

Stage

NameTypeDescription
idStringStage Id
textStringStage Name

Job Raw values

Model ID: job_rawValues

NameTypeDescription
jobInfoJob Info Raw ValuesRaw values associated with Job Info model.

Job Info Raw Values

NameTypeDescription
statusString
descriptionsList[Description]

Description

NameTypeDescription
idStringJob Description Id
descriptionStringJob Description Text

Event Data Example

{
  "info": {
    "id": "CqrN2sN5U89GaYO",
    "title": "SDE 1",
    "description": "Junior Developer Backend",
    "createdAt": "1970-01-01T00:00:00Z",
    "updatedAt": "1970-01-01T00:00:00Z",
    "closedAt": "1970-01-01T00:00:00Z",
    "status": "OPEN",
    "confidential": false,
    "jobCodes": [
      "7MBL9rEloOSbq1R",
      "85LY1duVrbHYMk3"
    ],
    "infoUrl": "www.linktoJob.com",
    "applyUrl": "www.linktoJob.com/apply"
  },
  "departments": [
    {
      "id": "CLtvELzXE1XzhaP",
      "name": "Backend"
    },
    {
      "id": "IDGpZLpmuNnJ8bG",
      "name": "Engineering"
    }
  ],
  "offices": [
    {
      "id": "AZ9Gl6M2IDZhrkw",
      "name": "HQ",
      "location": "Delhi, India",
        "address": {
        "addressLine1": "Clockhouse Place",
        "addressLine2": "Bedfont Road",
        "city": "Delhi",
        "state": "Delhi",
        "country": "India",
        "zipCode": "110044",
        "addressType": "NOT_SPECIFIED"
      }
    }
  ],
  "hiringManagers": [
    {
      "id": "Gis4YYXT3CugIRZ",
      "email": "[email protected]",
      "employeeId": "WWbJ35lotScHzpz"
    },
    {
      "id": "bF6uNyYrQU0n4QK",
      "email": "[email protected]",
      "employeeId": "vGeFgYQkMKPTE9a"
    }
  ],
  "recruiters": [
    {
      "id": "Gis4YYXT3CugIRZ",
      "email": "[email protected]",
      "employeeId": "WWbJ35lotScHzpz"
    }
  ],
  "stages": [
    {
      "id": "Q1do2hbFuBg2nrw",
      "text": "Phone Screen"
    },
    {
      "id": "IwwMkX3EkFfse",
      "text": "Technical Test"
    },
    {
      "id": "T3kfAZiN7Mgrs5",
      "text": "Technical Screen"
    },
    {
      "id": "8zTpCce7hkfde3",
      "text": "Culture Fit"
    }
  ],
  "rawValues": {
    "jobInfo": {
      "status": "open",
      "descriptions": [
        {
          "id": "123",
          "description": "Job Description in Short"
        },
         {
          "id": "124",
          "description": "Job Description in Detail"
        }
      ]
    }
  }
}