Deel: Retrieve paginated list of ATS attachment files
Deel atsAttachments.retrievePaginatedListOfAtsAttachmentFiles: arguments, response, policy and SDK examples.
← ATS attachments operations · Get started
Operation deel.atsattachments_retrievepaginatedlistofatsattachmentfiles_v2026_01_01
Provider route: GET /ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["atsAttachments"]["retrievePaginatedListOfAtsAttachmentFiles"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.atsAttachments.retrievePaginatedListOfAtsAttachmentFiles(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.ats_attachments.retrieve_paginated_list_of_ats_attachment_files(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.attachable_type_slug | string | Required within parent | One of: CANDIDATE, CAREER_PAGE_SETTING, JOB_POSTING, NOTE, OFFER, SENT_CANDIDATE_EMAIL, EMAIL_MESSAGE, TEMPORARY, EMAIL_TEMPLATE, JOB_ACTIVITY |
path.attachable_id | string | Required within parent | Format: uuid |
path.attachment_type_slug | string | Required within parent | One of: CV, LOGO, OFFER_LETTER, OTHER |
query | object | Optional | Additional keys: not allowed |
query.cursor | string | Optional | Maximum length: 1000 |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve paginated list of ATS attachment files — 200 response body |
Referenced models: Retrieve paginated list of ATS attachment files — 200 response body
Schemas
Section titled “Schemas”Retrieve paginated list of ATS attachment files — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of attachment objects |
data[] | Model | Each item | Expand Retrieve paginated list of ATS attachment files — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more results available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor for pagination to fetch next page Maximum length: 1000 |
next_cursor (anyOf 2) | null | Alternative | Cursor for pagination to fetch next page Maximum length: 1000 |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | number | Alternative | Total count of attachments Format: double |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve paginated list of ATS attachment files — 200 response body — data item
Retrieve paginated list of ATS attachment files — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ai_summary | JSON | Optional | |
ai_summary (anyOf 1) | string | Alternative | AI-generated summary of the attachment |
ai_summary (anyOf 2) | null | Alternative | AI-generated summary of the attachment |
attachable_id | string | Optional | Unique identifier for the attachable entity Format: uuid |
attachable_type_slug | string | Required within parent | Type of the attachable entity |
attachment_type_slug | string | Required within parent | Type of the attachment |
created_at | string | Optional | Timestamp when the attachment was created Format: date-time |
created_by_hris_organization_user_id | JSON | Optional | |
created_by_hris_organization_user_id (anyOf 1) | string | Alternative | User ID who created the attachment Format: uuid |
created_by_hris_organization_user_id (anyOf 2) | null | Alternative | User ID who created the attachment Format: uuid |
file_content_type | string | Required within parent | Content type of the file |
file_name | string | Required within parent | Name of the file |
id | string | Required within parent | Unique identifier for the attachment Format: uuid |
updated_at | string | Optional | Timestamp when the attachment was last updated Format: date-time |
url | string | Optional | URL of the attachment Format: url |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.atsattachments_retrievepaginatedlistofatsattachmentfiles_v2026_01_01. Catalog operation: atsattachments_retrievepaginatedlistofatsattachmentfiles_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["ats:read", "worker:read"]
Pinned headers: {"X-Version": "2026-01-01"}