Deel: Retrieve Benefits for EOR Contract
Deel eorBenefits.getEorbenefitsByContractId: arguments, response, policy and SDK examples.
← EOR benefits operations · Get started
Operation deel.eorbenefits_geteorbenefitsbycontractid
Provider route: GET /eor/{contract_id}/benefits. 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["eorBenefits"]["getEorbenefitsByContractId"]>[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.eorBenefits.getEorbenefitsByContractId(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_benefits.get_eorbenefits_by_contract_id(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.contract_id | string | Required within parent |
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 Benefits for EOR Contract — 200 response body |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body
Schemas
Section titled “Schemas”Retrieve Benefits for EOR Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve Benefits for EOR Contract — 200 response body — data item |
worker_benefits_link | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — worker benefits link Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it. |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — worker benefits link, Retrieve Benefits for EOR Contract — 200 response body — data item
Retrieve Benefits for EOR Contract — 200 response body — worker benefits link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Short-lived link where the worker completes their benefits enrolment and manages their benefits. Only returned for organisations set up as white-label with Deel, whose workers don't use the Deel app. Redirect the worker to it from your app; call this endpoint again for a new link after expires_at. Don't store, email or share it. |
expires_at | string | Optional | The date and time (UTC) after which the link no longer works. Format: date-time |
url | string | Optional | The short-lived URL to redirect the worker to. Format: uri |
Retrieve Benefits for EOR Contract — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enrollment_details | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details |
id | string | Optional | The unique ID of the benefit. |
name | string | Optional | The name of the benefit. |
offer_status | string | Optional | Indicates whether the benefit is offered. Known values: Offered, Not offered |
plan | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item plan |
provider | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item provider |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item plan, Retrieve Benefits for EOR Contract — 200 response body — data item provider, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
Retrieve Benefits for EOR Contract — 200 response body — data item plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the associated plan. |
Retrieve Benefits for EOR Contract — 200 response body — data item provider
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the benefit provider. |
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
current_cycle | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle |
plan | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan |
standard | Model | Optional | Expand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard |
status | string | Optional | The current enrollment status of the benefit (e.g. ENROLLED, AWAITING_ENROLLMENT, AWAITING_CONTRACT_ACTIVATION, AWAITING_CARRIER_CONFIRMATION). |
Referenced models: Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan, Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_monthly_contribution | string | Optional | The monthly contribution paid by the employer (client) for the current enrollment. Note: despite the field name, this value is the employer contribution, not the employee's. |
monthly_cost | string | Optional | The total monthly cost of the current enrollment. |
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the enrolled plan. |
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_monthly_contribution | JSON | Optional | |
employee_monthly_contribution (anyOf 1) | string | Alternative | The standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's. |
employee_monthly_contribution (anyOf 2) | null | Alternative | The standard monthly contribution paid by the employer (client) toward the benefit. Note: despite the field name, this value is the employer contribution, not the employee's. |
monthly_cost | JSON | Optional | |
monthly_cost (anyOf 1) | string | Alternative | The standard total monthly cost of the benefit. |
monthly_cost (anyOf 2) | null | Alternative | The standard total monthly cost of the benefit. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorbenefits_geteorbenefitsbycontractid. Catalog operation: eorbenefits_geteorbenefitsbycontractid. 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: ["contracts:read", "benefits:read"]
Pinned headers: {"X-Version": "2026-01-01"}