Skip to content

Deel: Retrieve HRX documents

Deel hrxDocuments.retrieveHrxDocuments: arguments, response, policy and SDK examples.

← HRX documents operations · Get started

Operation deel.hrxdocuments_retrievehrxdocuments_v2026_01_01

Provider route: GET /eor/contracts/{contract_id}/hrx-documents. Alter supplies the connection’s credentials and routing.

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["hrxDocuments"]["retrieveHrxDocuments"]>[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.hrxDocuments.retrieveHrxDocuments(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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.hrx_documents.retrieve_hrx_documents(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cursorstringOptional
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve HRX documents — 200 response body

Referenced models: Retrieve HRX documents — 200 response body

Retrieve HRX documents — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of employee documents
data[]ModelEach itemExpand Retrieve HRX documents — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more pages available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to use for the next page. Null if there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to use for the next page. Null if there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of documents available across all pages
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve HRX documents — 200 response body — data item

Retrieve HRX documents — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
categorystringRequired within parentType of the document category
category_descriptionstringRequired within parentDescription of the document category
category_idstringRequired within parentUnique identifier for the document category
Format: uuid
category_typestringRequired within parentType of the document category
Known values: EMPLOYMENT_AGREEMENT, ONBOARDING_REGISTRATION, OFFBOARDING_TERMINATION, TAX_FISCAL, STATUS_BENEFITS, VISA_TRAVEL_SUPPORT, OTHER
created_atstringRequired within parentWhen the document was created
Format: date-time
idstringRequired within parentUnique identifier for the employee document
Format: uuid
namestringRequired within parentName of the employee document
updated_atstringRequired within parentWhen the document was last updated
Format: date-time

SDK function policy ID: deel.hrxdocuments_retrievehrxdocuments_v2026_01_01. Catalog operation: hrxdocuments_retrievehrxdocuments_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: ["worker:read", "contracts:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.