GET
/
ats
/
candidates
/
{candidate_id}
/
attachments
Get candidate attachments
curl --request GET \
  --url https://api.kombo.dev/v1/ats/candidates/{candidate_id}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'
{
  "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!"
    }
  ]
}
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
Examples:
{
  "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.