Reading Applications allows you to retrieve all applications from an ATS.

​
Reading All Applications

In order to ensure you read all applications from your customers ATS, you must configure the Only Sync Created Applications toggle to off in your dashboard.

This can be done here in your Kombo Dashboard.

Kombo syncs data on a regular interval from the ATS. For the screening use case, there is also the possibility of listening for upstream webhooks. With upstream webhooks, if a new candidate is created in the ATS, you will receive a remote-event-received webhook allowing you to sync any new data in the ATS. More information on upstream webhooks can be found here.

Once a sync is completed you can listen for sync-finished webhook. Then using the GET Applications Endpoint, applications can be read from an ATS into your system.

​
Set Screening Trigger stage

You will want identify the trigger stage(s) for your screening. On the Get Jobs Endpoint, you will see the stages object.

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        "name": "Backend Engineer",
        ...,
        "stages": [
          {
            "id": "3PJ8PZhZZa1eEdd2DtPNtVup",
            "remote_id": "32",
            "name": "Initial Screening",
            "index": 0
          },
          {
            "id": "HWUTwvyx2wLoSUHphiWVrp28",
            "remote_id": "38",
            "name": "Interview",
            "index": 1
          },
        ],
      }
    ]
  }
}

You will have to identify the stage which screening should occur. It is possible to use the index, stages.id or stage name to identify the stage(s) to trigger screening, you may also want to involve your customer in identifying the trigger stage. We would recommend using the stages.id.

If you plan on moving an application we would recommend that you also identify the stages.id for the next stage in the application process and store this in your database. As you will need this in order to move the application to the next stage.

​
Tracking Stages

You will have to keep track of applications during the application process in order to check whether the stage of the application has changed to the trigger stage. To see whether the stage of an application has changed, you have to implement some tracking logic on your end by calling the Get Applications Endpoint with the updated_after filter and then comparing the stage of each candidate with the stage you currently have in your system.

When you fetch the applications via the Get Applications endpoint, you will get the current_stage_id and current_stage properties for each application. The current_stage is just an expanded version of the current_stage_id so you can use either of them.

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32",
        ...
        "current_stage_id": "5J7L4b48wBfffYwek9Az9pkM",
        ...
        "current_stage": {
          "id": "5J7L4b48wBfffYwek9Az9pkM",
          "remote_id": "32",
          "name": "Initial Screening"
        },
      }
    ]
  }
}

Please note that in many ATS, each job can have a custom hiring process (i.e. can have a custom configuration of application stages). You can find the stages for each job on the stages property when calling the Get Jobs endpoint.

​
Get Attachments

As a screening company you may want to read in candidates CVs. This can be done using the Get application Attachments Endpoint.

For every application you must make a request to retrieve the attachment

  • This endpoint requires the permission Read document attachments to be enabled in your scope configuration.

You will need to provide the application_id for each application you want to get the attachments for.

curl --request GET \
  --url https://api.kombo.dev/v1/ats/applications/{123abc}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'

​
Screening Questions

Once you read in applications you can get the screening questions and answers from the screening_question_answers object on the get applications endpoint response.

"screening_question_answers": [
          {
            "answer": {
              "choice": "TypeScript"
            },
            "question": {
              "remote_id": "48b4d36a-1d4b-4c50-ada7-9519078e65b4",
              "title": "Which is your primary programming language",
              "type": "SINGLE_SELECT"
            }
          }
        ],