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 ID | Event Data Key | Description |
|---|---|---|
job_info | info | Get the data of a job like id, title, createdAt, status, url etc |
job_departments | departments | Get information about departments which the job belongs to |
job_offices | offices | Get information about the offices which the job belongs to |
job_hiringManagers | hiringManagers | Get information about the hiring managers of the job |
job_recruiters | recruiters | Get the recruiters associated with the job |
job_stages | stages | Get information about all the stages associated with the job |
job_rawValues | rawValues | Get 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
| Name | Type | Description |
|---|---|---|
id | String | User ID in the ATS system |
email | String | |
employeeId | String | Employee ID of the user |
Job Info
Model ID: job_info
| Name | Type | Description |
|---|---|---|
|
|
Job ID |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
One of |
|
|
Indicates whether the job is confidential |
|
|
Typically an additional identifier used to reference the job provided by the organization posting the job. |
|
|
URL that points to the job's information page |
|
|
URL that points to the job's apply page |
Job Departments
Model ID: job_departments
| Name | Type | Description |
|---|---|---|
departments | List[Department] | Departments associated with the job |
Department
| Name | Type | Description |
|---|---|---|
id | String | ID provided by the ATS |
name | String |
Job Offices
Model ID: job_offices
| Name | Type | Description |
|---|---|---|
offices | List[Office] | Offices associated with the job |
Office
| Name | Type | Description |
|---|---|---|
id | String | ID provided by the ATS |
name | String | |
location | String | |
address | Address | Please refer to https://developers.getknit.dev/reference/base-models#address |
Job Hiring Managers
Model ID: job_hiringManagers
| Name | Type | Description |
|---|---|---|
hiringManagers | List[User] | Hiring Managers associated with the job |
Job Recruiters
Model ID: job_recruiters
| Name | Type | Description |
|---|---|---|
recruiters | List[User] | Recruiters associated with the job |
Job Stages
Model ID: job_stages
| Name | Type | Description |
|---|---|---|
stages | List[Stage] |
Stage
| Name | Type | Description |
|---|---|---|
id | String | Stage Id |
text | String | Stage Name |
Job Raw values
Model ID: job_rawValues
| Name | Type | Description |
|---|---|---|
jobInfo | Job Info Raw Values | Raw values associated with Job Info model. |
Job Info Raw Values
| Name | Type | Description |
|---|---|---|
status | String | |
descriptions | List[Description] |
Description
| Name | Type | Description |
|---|---|---|
id | String | Job Description Id |
description | String | Job 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"
}
]
}
}
}