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 ID | Event Data Key | Description |
|---|---|---|
application_info | info | Get the data of an application like applicant details, job id, appliedAt, owner, creditedTo etc |
application_stage | currentStage | Get information about the application's current stage |
application_interviews | interviews | Get information about all the interviews associated with an application like id, subject, scheduledStart, scheduledEnd, status, interviewers etc |
application_rejection | rejection | Get information about an application's rejection like id, reason etc |
application_offers | offers | Get the offers associated with an application |
application_attachments | attachments | Get 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
| Name | Type | Description |
|---|---|---|
id | String | User ID in the ATS system |
email | String | |
employeeId | String | Employee ID of the user |
Application Info
Model ID: application_info
| Name | Type | Description |
|---|---|---|
|
|
Application ID |
|
|
One of |
|
|
Candidate Details |
|
|
One of |
|
|
|
|
|
|
|
|
Job ID of the application. More info about the Job data model can be found here |
|
|
Owner of the application in the ATS system |
|
|
The user who will receive credit for this application |
Candidate
| Name | Type | Description |
|---|---|---|
id | String | Candidate ID |
firstName | String | |
lastName | String | |
phones | Phone | |
emails | List[Email] | |
links | List[String] | Links associated with the candidate like LinkedIn, Website etc |
location | String |
Phone
| Name | Type | Description |
|---|---|---|
|
|
One of |
|
|
Email
| Name | Type | Description |
|---|---|---|
|
|
One of |
|
|
Application Stage
Model ID: application_stage
| Name | Type | Description |
|---|---|---|
currentStage | Stage |
Stage
| Name | Type | Description |
|---|---|---|
id | String | Stage Id |
text | String | Stage Name |
Application Interviews
Model ID: application_interviews
| Name | Type | Description |
|---|---|---|
interviews | List[Interview] |
Interview
| Name | Type | Description |
|---|---|---|
|
|
Interview Id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Stage the application was in when this interview was scheduled |
|
|
|
|
|
|
|
|
|
|
|
One of |
Application Rejection
Model ID: application_rejection
| Name | Type | Description |
|---|---|---|
id | String | |
text | String | |
rejectedAt | Date |
Application Offers
Model ID: application_offers
| Name | Type | Description |
|---|---|---|
offers | List[Offer] |
Offer
| Name | Type | Description |
|---|---|---|
|
|
|
|
|
One of |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Application Attachments
Model ID: application_attachments
| Name | Type | Description |
|---|---|---|
attachments | List[Attachment] |
Attachment
| Name | Type | Description |
|---|---|---|
|
|
One of |
|
|
File Name |
|
|
Downloadable link of the file. (Caution: Some ATS systems might only provide a short lived link) |
|
|
Content of the attachment |
|
|
When this attachment was created |
|
|
|
Attachment Content
| Name | Type | Description |
|---|---|---|
|
|
|
|
|
One of |
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",
"startDate": "1970-01-01T00:00:00Z",
"hireDate": "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",
"startDate": "1970-01-01T00:00:00Z",
"hireDate": "1970-01-01T00:00:00Z"
}
],
"attachments": [
{
"type": "OFFER_LETTER",
"name": "Offer 1",
"link": "abc.com/offer1",
"createdAt": "1970-01-01T00:00:00Z",
"downloadLink": "https://api.getknit.dev?token=hdc-29393393"
},
{
"type": "COVER_LETTER",
"name": "Cover Letter",
"attachmentContent": {
"content": "b29fTVJrRWU5dW1CU2NQNUlTYkFkc3dJdTpzbGFjaw==",
"encoding": "BASE64"
},
"createdAt": "1970-01-01T00:00:00Z"
}
]
}