How to get the list of Applications

There are two ways to fetch the list of applications from your integrations:

1. Syncs (Webhook-based Bulk Reads)

Syncs provide an automated, push-based approach for bulk data retrieval. Once you set up a sync for an integration, Knit polls the source app for changes and sends updates straight to your webhook. This webhook-based model eliminates the need for you to continuously pull data.

Read more about syncs and webhooks here: https://developers.getknit.dev/docs/register-webhook-url#/

2. Read APIs (On-demand Individual Reads)

Read APIs provide on-demand access to specific data through request-response calls. These are standard GET/List operations that allow you to retrieve application information whenever needed.

You can refer to applicant tracking systems APIs here: https://developers.getknit.dev/reference/list-applications#/

Data Model

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
`application_question_responses`	`questionResponses`	Get the questionResponses to job questions submitted by the applicant

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
`id`	`String`	Application ID
`status`	`Enum`	One of `ACTIVE` `REJECTED` `HIRED` `NOT_SPECIFIED`
`candidate`	`Candidate`	Candidate Details
`origin`	`Enum`	One of `AGENCY`, `REFERRAL`, `EXTERNAL` `NOT_SPECIFIED`
`appliedAt`	`Date`
`updatedAt`	`Date`
`jobId`	`String`	Job ID of the application. More info about the Job data model can be found here
`owner`	`User`	Owner of the application in the ATS system
`creditedTo`	`User`	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
`type`	`Enum`	One of `WORK`, `PERSONAL`, `SKYPE` `NOT_SPECIFIED`
`phoneNumber`	`String`

Email

Name	Type	Description
`type`	`Enum`	One of `WORK`, `PERSONAL`, `NOT_SPECIFIED`
`email`	`String`

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
`id`	`String`	Interview Id
`subject`	`String`
`createdAt`	`Date`
`scheduledStart`	`Date`
`scheduledEnd`	`Date`
`stage`	`Stage`	Stage the application was in when this interview was scheduled
`interviewers`	`List[User]`
`location`	`String`
`creator`	`User`
`status`	`Enum`	One of `SCHEDULED` `AWAITING_FEEDBACK` `COMPLETE` `CANCELLED` `NOT_SPECIFIED`

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
`id`	`String`
`status`	`Enum`	One of `IN_PROGRESS` `SIGNED` `DENIED` `DEPRECATED` `NOT_SPECIFIED`
`createdAt`	`Date`
`sentAt`	`Date`
`closedAt`	`Date`
`startDate`	`Date`
`hireDate`	`Date`

Application Attachments

Model ID: application_attachments

Name	Type	Description
`attachments`	`List[Attachment]`

Attachment

Name	Type	Description
`type`	`Enum`	One of `RESUME` `COVER_LETTER` `OFFER_LETTER` `NOT_SPECIFIED`
`name`	`String`	File Name
`link`	`String`	Downloadable link of the file. (Caution: Some ATS systems might only provide a short lived link)
`attachmentContent`	`AttachmentContent`	Content of the attachment
`createdAt`	`Date`	When this attachment was created
`downloadLink`	`String`	Prefer using the `downloadLink` field over `link` if both are present. Content will be base64 encoded. Sample JSON: `{ "success": true, "data": { "content": "Base64 Encoded content" } }`

Attachment Content

Name	Type	Description
`content`	`String`
`encoding`	`Enum`	One of `BASE64` `NOT_SPECIFIED`

Application Question Response

Model ID: application_question_responses

Name	Type	Description
`questionResponses`	`List[QuestionResponse]`

QuestionResponse

Name	Type	Description
`id`	`String`	Unique identifier for the question response
`applicationId`	`String`	Reference to the job application
`questionId`	`String`	Reference to the question
`questionType`	`Enum`	One of: `TEXT` `SINGLE_CHOICE` `MULTIPLE_CHOICE` `YES_NO` `NUMBER` `DATE` `FILE_UPLOAD` `DROPDOWN` `RATING_SCALE`
`questionText`	`String`	The actual question being asked
`required`	`Boolean`	Whether the question is mandatory
`answer`	`Object`	The response data (see Answer schema)
`skipped`	`Boolean`	Whether the question was skipped
`validationErrors`	`List[String]`	Any validation errors for the response
`submittedAt`	`Date`	When the response was submitted
`updatedAt`	`Date`	When the response was last updated

Answer

Name	Type	Description
`text`	`String`	Text response for TEXT type questions
`selectedOption`	`String`	Selected option for SINGLE_CHOICE questions
`selectedOptions`	`List[String]`	Selected options for MULTIPLE_CHOICE questions
`numberValue`	`Number`	Numeric response for NUMBER type questions
`dateValue`	`Date`	Date response for DATE type questions
`ratingValue`	`Number`	Rating response for RATING_SCALE type questions
`file`	`Object`	The response file data (see AnswerFile schema)

AnswerFile

Name	Type	Description
`fileName`	`String`	Name of the uploaded file
`fileUrl`	`String`	URL where the file is stored
`fileSize`	`Number`	Size of the file in bytes
`mimeType`	`String`	MIME type of the file
`uploadedAt`	`Date`	When the file was uploaded

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": "abc@def.com"
        }
      ],
      "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": "hr@org.com",
      "employeeId": "re8AKBnyujPZ4Yb"
    },
    "creditedTo": {
      "id": "UxXF6C3PwZ4gD4c",
      "email": "recruiter@org.com",
      "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": "tech@org.com",
          "employeeId": "WvDRi2Hw9wBOGpp"
        },
        {
          "id": "LjwEnf8vBXMCa1q",
          "email": "cto@org.com",
          "employeeId": "HYajD4pt5NNKPto"
        },
        {
          "id": "uf6XtHjVqoJATnD",
          "email": "vp_eng@org.com",
          "employeeId": "97XBkbEiDZhlpg4"
        }
      ],
      "location": "zoom.com/interview",
      "creator": {
        "id": "7hHbRoqaZrUWKsE",
        "email": "hrbp@org.com",
        "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/v1.0/ats.attachment.download?token=hdc-29393393"
    },
    {
      "type": "COVER_LETTER",
      "name": "Cover Letter",
      "attachmentContent": {
        "content": "b29fTVJrRWU5dW1CU2NQNUlTYkFkc3dJdTpzbGFjaw==",
        "encoding": "BASE64"
      },
      "createdAt": "1970-01-01T00:00:00Z"
    }
  ],
  "questionResponses": [
    {
      "id": "qr_12345",
      "applicationId": "app_789",
      "questionId": "q_123",
      "questionType": "TEXT",
      "questionText": "Tell us about yourself",
      "required": true,
      "answer": {
        "text": "I am a software engineer with 5 years of experience"
      },
      "skipped": false,
      "validationErrors": [],
      "submittedAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2023-01-01T12:00:00Z"
    },
    {
      "id": "qr_12346",
      "applicationId": "app_789",
      "questionId": "q_124",
      "questionType": "MULTIPLE_CHOICE",
      "questionText": "Which programming languages do you know?",
      "required": true,
      "answer": {
        "selectedOptions": ["Python", "JavaScript", "Java"]
      },
      "skipped": false,
      "validationErrors": [],
      "submittedAt": "2023-01-01T12:01:00Z",
      "updatedAt": "2023-01-01T12:01:00Z"
    },
    {
      "id": "qr_12347",
      "applicationId": "app_789",
      "questionId": "q_125",
      "questionType": "FILE_UPLOAD",
      "questionText": "Please upload your certification",
      "required": true,
      "answer": {
        "file": {
          "fileName": "aws-certification.pdf",
          "fileUrl": "https://storage.example.com/aws-cert.pdf",
          "fileSize": 1024567,
          "mimeType": "application/pdf",
          "uploadedAt": "2023-01-01T12:02:00Z"
        }
      },
      "skipped": false,
      "validationErrors": [],
      "submittedAt": "2023-01-01T12:02:00Z",
      "updatedAt": "2023-01-01T12:02:00Z"
    },
    {
      "id": "qr_12348",
      "applicationId": "app_789",
      "questionId": "q_126",
      "questionType": "RATING_SCALE",
      "questionText": "Rate your Java expertise (1-5)",
      "required": true,
      "answer": {
        "ratingValue": 4
      },
      "skipped": false,
      "validationErrors": [],
      "submittedAt": "2023-01-01T12:03:00Z",
      "updatedAt": "2023-01-01T12:03:00Z"
    }
  ]
}