Get candidate attachments

Python

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.ats.get_candidate_attachments(candidate_id="8Xi6iZrwusZqJmDGXs49GBmJ")

    # Handle response
    print(res)

import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.getCandidateAttachments({
    candidate_id: "8Xi6iZrwusZqJmDGXs49GBmJ",
  });

  console.log(result);
}

run();

require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  security: Models::Shared::Security.new(
    api_key: '<YOUR_BEARER_TOKEN_HERE>'
  )
)
res = s.ats.get_candidate_attachments(candidate_id: '8Xi6iZrwusZqJmDGXs49GBmJ')

unless res.get_ats_candidates_candidate_id_attachments_positive_response.nil?
  # handle response
end

const options = {
  method: 'GET',
  headers: {'X-Integration-Id': '<x-integration-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Integration-Id: <x-integration-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Integration-Id", "<x-integration-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments")
  .header("X-Integration-Id", "<x-integration-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

{
  "status": "success",
  "data": {
    "results": [
      {
        "id": "EYJjhMQT3LtVKXnTbnRT8s6U",
        "application_id": null,
        "candidate_id": "BTbkvY2w5ou3z3hdwuKcKzDh",
        "type": "CV",
        "remote_id": "GUzE666zfyjeoCJX6A8n7wh6",
        "data_url": "https://resources.kombo.dev/EYJjhMQT3LtVKXnTbnRT8s6U",
        "file_name": "Frank Doe CV.pdf",
        "content_type": "application/pdf",
        "remote_created_at": null,
        "remote_updated_at": null
      }
    ]
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

GET

ats

candidates

{candidate_id}

attachments

Python

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.ats.get_candidate_attachments(candidate_id="8Xi6iZrwusZqJmDGXs49GBmJ")

    # Handle response
    print(res)

import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.ats.getCandidateAttachments({
    candidate_id: "8Xi6iZrwusZqJmDGXs49GBmJ",
  });

  console.log(result);
}

run();

require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  security: Models::Shared::Security.new(
    api_key: '<YOUR_BEARER_TOKEN_HERE>'
  )
)
res = s.ats.get_candidate_attachments(candidate_id: '8Xi6iZrwusZqJmDGXs49GBmJ')

unless res.get_ats_candidates_candidate_id_attachments_positive_response.nil?
  # handle response
end

const options = {
  method: 'GET',
  headers: {'X-Integration-Id': '<x-integration-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Integration-Id: <x-integration-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Integration-Id", "<x-integration-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments")
  .header("X-Integration-Id", "<x-integration-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

{
  "status": "success",
  "data": {
    "results": [
      {
        "id": "EYJjhMQT3LtVKXnTbnRT8s6U",
        "application_id": null,
        "candidate_id": "BTbkvY2w5ou3z3hdwuKcKzDh",
        "type": "CV",
        "remote_id": "GUzE666zfyjeoCJX6A8n7wh6",
        "data_url": "https://resources.kombo.dev/EYJjhMQT3LtVKXnTbnRT8s6U",
        "file_name": "Frank Doe CV.pdf",
        "content_type": "application/pdf",
        "remote_created_at": null,
        "remote_updated_at": null
      }
    ]
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}

Supported integrations

This feature is currently available for the following integrations:

You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.

This endpoint calls the ATS on every request. To get the files of all candidates without a request per candidate, use synced attachments.

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

Authorizations

Authorization

string

header

required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

X-Integration-Id

string

required

ID of the integration you want to interact with.

Path Parameters

candidate_id

string

required

The Kombo ID of the candidate you want to obtain attachments for.

Response

GET /ats/candidates/:candidate_id/attachments Positive response

status

string

required

Allowed value: "success"

data

object

required

Show child attributes

Example:

{
  "results": [
    {
      "id": "EYJjhMQT3LtVKXnTbnRT8s6U",
      "application_id": null,
      "candidate_id": "BTbkvY2w5ou3z3hdwuKcKzDh",
      "type": "CV",
      "remote_id": "GUzE666zfyjeoCJX6A8n7wh6",
      "data_url": "https://resources.kombo.dev/EYJjhMQT3LtVKXnTbnRT8s6U",
      "file_name": "Frank Doe CV.pdf",
      "content_type": "application/pdf",
      "remote_created_at": null,
      "remote_updated_at": null
    }
  ]
}

warnings

object[]

required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.

Show child attributes

General

Features

Guides

ATS API Reference

General API Reference

Get candidate attachments

Authorizations

Headers

Path Parameters

Response