> ## 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. # Get attachments > Retrieve all attachments. 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. Returns the attachments Kombo synced into your file destination. [Attachments](/ats/features/attachments) compares synced attachments with reading files on demand. 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)` ## OpenAPI ````yaml GET /ats/attachments openapi: 3.1.0 info: title: Kombo API version: 1.0.0 servers: - url: https://api.kombo.dev/v1 description: Kombo EU API - url: https://api.us.kombo.dev/v1 description: Kombo US API - url: https://api.ca.kombo.dev/v1 description: Kombo CA API security: - ApiKey: [] tags: - name: General - name: Kombo Connect description: >- Endpoints for Kombo Connect, our end-user-facing flow for setting up new integrations. - name: Unified HRIS API description: Unified endpoints to access all the HR concepts you might need. - name: Unified ATS API description: Unified endpoints to access all the ATS concepts you might need. - name: Unified ATS (Assessment & Background Check) API description: >- Unified endpoints to operate Assessments and Background Checks for many applicant tracking systems. - name: Unified LMS API description: Unified endpoints to access all the LMS concepts you might need. - name: AI Apply description: Endpoints for AI-powered job application features. - name: Custom Endpoints description: Custom integration-specific endpoints. paths: /ats/attachments: get: tags: - Unified ATS API summary: Get attachments description: >- Retrieve all attachments. 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. Returns the attachments Kombo synced into your file destination. [Attachments](/ats/features/attachments) compares synced attachments with reading files on demand. 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)` operationId: GetAtsAttachments parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: join:HWUTwvyx2wLoSUHphiWVrp28 required: true - name: cursor in: query required: false description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterPageSize' - name: updated_after in: query required: false description: >- 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](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, only changes to the returned record itself are considered. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterUpdatedAfter' - name: include_deleted in: query required: false description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterIncludeDeleted' - name: ignore_unsupported_filters in: query required: false description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. schema: $ref: >- #/components/schemas/GetAtsAttachmentsParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterRemoteIds' - name: candidate_ids in: query required: false description: >- 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. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterCandidateIds' - name: application_ids in: query required: false description: >- 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. schema: $ref: '#/components/schemas/GetAtsAttachmentsParameterApplicationIds' responses: '200': description: GET /ats/attachments Positive response content: application/json: schema: $ref: '#/components/schemas/GetAtsAttachmentsPositiveResponse' examples: example1: value: status: success 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 default: $ref: '#/components/responses/ErrorResponseATS' x-codeSamples: - lang: python label: GetAtsAttachments source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.ats.get_ats_attachments(page_size=100, include_deleted=False, ignore_unsupported_filters=False) while res is not None: # Handle items res = res.next() - lang: typescript label: GetAtsAttachments source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.ats.getAtsAttachments({}); for await (const page of result) { console.log(page); } } run(); - lang: ruby label: GetAtsAttachments source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.ats.get_ats_attachments(page_size: 100, include_deleted: false, ignore_unsupported_filters: false) unless res.get_ats_attachments_positive_response.nil? # handle response end components: schemas: GetAtsAttachmentsParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetAtsAttachmentsParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetAtsAttachmentsParameterUpdatedAfter: description: >- 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](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, only changes to the returned record itself are considered. type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString GetAtsAttachmentsParameterIncludeDeleted: type: string enum: - 'true' - 'false' default: 'false' description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. GetAtsAttachmentsParameterIgnoreUnsupportedFilters: type: string enum: - 'true' - 'false' default: 'false' description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. GetAtsAttachmentsParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetAtsAttachmentsParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetAtsAttachmentsParameterCandidateIds: type: string description: >- 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. GetAtsAttachmentsParameterApplicationIds: type: string description: >- 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. GetAtsAttachmentsPositiveResponse: type: object properties: status: type: string const: success data: type: object properties: next: type: - string - 'null' description: >- Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages. results: type: array items: type: object properties: id: type: string description: >- The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. remote_id: type: string description: >- The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. candidate_id: type: string description: >- The Kombo ID of the candidate this attachment belongs to. The ID can be used to retrieve the candidate from the `get candidates` endpoint. application_id: type: - string - 'null' description: >- The Kombo ID of the application this attachment belongs to, when the ATS files it under one specific application. Many systems attach files to the candidate instead, in which case this is `null`. type: type: - string - 'null' enum: - CV - COVER_LETTER - OTHER description: >- What the file is used for in the ATS. Anything that is neither a CV nor a cover letter is reported as `OTHER`. file_name: type: - string - 'null' description: The name of the file as reported by the ATS. content_ref: discriminator: propertyName: type oneOf: - type: object properties: type: type: string const: s3 bucket: type: string description: The bucket the object was written to. key: type: string description: >- The full object key, including the prefix configured on the file destination. required: - type - bucket - key - type: 'null' description: >- Where we stored the file in the bucket you configured. The file is written before the attachment shows up here, so this is set on every attachment you can read. remote_created_at: description: >- The date and time the object was created in the remote system. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_updated_at: description: >- A timestamp retrieved from the remote system, describing when the resource was last updated. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_data: type: - object - 'null' additionalProperties: true description: >- **(⚠️ Deprecated)** Remote data can no longer be enabled. This field is `null` unless remote data was already enabled for this model in your scope config. [Read more](https://docs.kombo.dev/hris/getting-started/remote-data) deprecated: true changed_at: description: >- The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated. type: string format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString remote_deleted_at: description: >- The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString required: - id - remote_id - candidate_id - application_id - type - file_name - remote_created_at - remote_updated_at - remote_data - changed_at - remote_deleted_at examples: - 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 required: - next - results examples: - 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 required: - status - data responses: ErrorResponseATS: description: The standard error response with the error codes for the ATS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - ATS.JOB_CLOSED - ATS.APPLICATION_ALREADY_EXISTS example: ATS.JOB_CLOSED description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.