Skip to content

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.

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 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.eor_benefits.get_eorbenefits_by_contract_id(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve Benefits for EOR Contract — 200 response body

Referenced models: Retrieve Benefits for EOR Contract — 200 response body

Retrieve Benefits for EOR Contract — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve Benefits for EOR Contract — 200 response body — data item
worker_benefits_linkModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRootShort-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_atstringOptionalThe date and time (UTC) after which the link no longer works.
Format: date-time
urlstringOptionalThe short-lived URL to redirect the worker to.
Format: uri
Retrieve Benefits for EOR Contract — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
enrollment_detailsModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
idstringOptionalThe unique ID of the benefit.
namestringOptionalThe name of the benefit.
offer_statusstringOptionalIndicates whether the benefit is offered.
Known values: Offered, Not offered
planModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item plan
providerModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the associated plan.
Retrieve Benefits for EOR Contract — 200 response body — data item provider
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the benefit provider.
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details
FieldTypePresenceDescription and constraints
$objectRoot
current_cycleModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details current cycle
planModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan
standardModelOptionalExpand Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
statusstringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRoot
employee_monthly_contributionstringOptionalThe 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_coststringOptionalThe total monthly cost of the current enrollment.
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details plan
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the enrolled plan.
Retrieve Benefits for EOR Contract — 200 response body — data item enrollment details standard
FieldTypePresenceDescription and constraints
$objectRoot
employee_monthly_contributionJSONOptional
employee_monthly_contribution (anyOf 1)stringAlternativeThe 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)nullAlternativeThe 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_costJSONOptional
monthly_cost (anyOf 1)stringAlternativeThe standard total monthly cost of the benefit.
monthly_cost (anyOf 2)nullAlternativeThe standard total monthly cost of the benefit.

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"}

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.