Sign in
Unified ATS API

Get attachments

Retrieve all attachments.

These attachments are already synced, so this endpoint never calls the ATS and the files sit in the destination you configured.

The on-demand alternatives call the ATS and return a data_url we host: get candidate attachments for every file of one candidate, get application attachments for the files of one application.

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

get/ats/attachments

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

The number of results to return per page. Maximum is 250.

updated_afterstring date-time

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. Returns records where either the record itself OR its nested data has been updated since this timestamp, even if the record's own changed_at field remains unchanged.

If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

For more details, see Understanding changed_at vs updated_after Behavior.

For this endpoint, only changes to the returned record itself are considered.

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. Returns records where either the record itself OR its nested data has been updated since this timestamp, even if the record's own changed_at field remains unchanged.

If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

For more details, see Understanding changed_at vs updated_after Behavior.

For this endpoint, only changes to the returned record itself are considered.

include_deleted'true' | 'false'

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

ignore_unsupported_filters'true' | 'false'

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

When set to true, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

remote_idsstring

Filter by a comma-separated list of remote IDs.

Filter by a comma-separated list of remote IDs.

candidate_idsstring

Filter by a comma-separated list of candidate IDs. Prefer filtering by candidate_ids when you want every file a candidate has, across all their applications.

Filter by a comma-separated list of candidate IDs. Prefer filtering by candidate_ids when you want every file a candidate has, across all their applications.

application_idsstring

Filter by a comma-separated list of application IDs. We will only return attachments that the ATS filed under any of these applications, which excludes the files that hang off the candidate directly.

Filter by a comma-separated list of application IDs. We will only return attachments that the ATS filed under any of these applications, which excludes the files that hang off the candidate directly.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /ats/attachments Positive response

status'success' required

Example response

{
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "EYJjhMQT3LtVKXnTbnRT8s6U",
        "remote_id": "1001",
        "candidate_id": "BTbkvY2w5ou3z3hdwuKcKzDh",
        "application_id": "H5daSm8e85Dmvmne3wLeCPhX",
        "type": "CV",
        "file_name": "Frank Doe CV.pdf",
        "content_ref": {
          "bucket": "acme-kombo-attachments",
          "key": "kombo/ats_attachments/integrations/greenhousev3:BsUP8fPMzHDo/candidates/BTbkvY2w5ou3z3hdwuKcKzDh/EYJjhMQT3LtVKXnTbnRT8s6U",
          "type": "s3"
        },
        "remote_created_at": "2022-08-07T14:01:29.196Z",
        "remote_updated_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null,
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null
      }
    ]
  }
}

Changes

Changed in 1 of the 27 revisions of this API.1