Deel: Retrieve worker resignations
Deel eorWorkerOffboarding.getEmployeeResignations: arguments, response, policy and SDK examples.
← EOR worker offboarding operations · Get started
Operation deel.eorworkeroffboarding_getemployeeresignations
Provider route: GET /eor/workers/resignations. 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["eorWorkerOffboarding"]["getEmployeeResignations"]>[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.eorWorkerOffboarding.getEmployeeResignations(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.eor_worker_offboarding.get_employee_resignations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.status | string | Optional | One of: AWAITING_SIGNATURE, SIGNED |
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 worker resignations — 200 response body |
Referenced models: Retrieve worker resignations — 200 response body
Schemas
Section titled “Schemas”Retrieve worker resignations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve worker resignations — 200 response body — data item |
Referenced models: Retrieve worker resignations — 200 response body — data item
Retrieve worker resignations — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the employee contract. |
created_at | string | Required within parent | The date and time the resignation was created Format: date-time |
desired_end_date | JSON | Required within parent | |
desired_end_date (anyOf 1) | string | Alternative | The desired end date of the resignation Format: date-time |
desired_end_date (anyOf 2) | null | Alternative | The desired end date of the resignation Format: date-time |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The confirmed end date of the resignation Format: date-time |
end_date (anyOf 2) | null | Alternative | The confirmed end date of the resignation Format: date-time |
id | string | Required within parent | The unique identifier of the resignation Format: uuid |
resignation_letter | JSON | Required within parent | |
resignation_letter (anyOf 1) | Model | Alternative | Expand Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED |
resignation_letter (anyOf 2) | null | Alternative | |
status | string | Required within parent | The status of the resignation Known values: CREATED, COMPLETED, AWAITING_REFUND, PROCESSING, AWAITING_TRIAGE, AWAITING_PROCESSING, CANCELLED, AWAITING_PTO |
updated_at | string | Required within parent | The date and time the resignation was updated Format: date-time |
Referenced models: Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED
Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the resignation letter was created Format: date-time |
id | string | Required within parent | The unique identifier of the resignation letter Format: uuid |
signature | JSON | Required within parent | |
signature (anyOf 1) | string | Alternative | The signature of the resignation letter |
signature (anyOf 2) | null | Alternative | The signature of the resignation letter |
signed_at | JSON | Required within parent | |
signed_at (anyOf 1) | string | Alternative | The date and time the resignation letter was signed Format: date-time |
signed_at (anyOf 2) | null | Alternative | The date and time the resignation letter was signed Format: date-time |
status | string | Required within parent | The status of the resignation letter Known values: AWAITING_SIGNATURE, SIGNED |
updated_at | string | Required within parent | The date and time the resignation letter was updated Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorworkeroffboarding_getemployeeresignations. Catalog operation: eorworkeroffboarding_getemployeeresignations. 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"]
Pinned headers: {"X-Version": "2026-01-01"}