Skip to main content
GET
/
ats
/
candidates
/
{candidate_id}
/
attachments
TypeScript
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();
{ "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!" } ] }

Documentation Index

Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt

Use this file to discover all available pages before exploring further.

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
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.