Deel: Retrieve Benefits by Country
Deel eorHiring.getBenefits: arguments, response, policy and SDK examples.
← EOR hiring operations · Get started
Operation deel.eorhiring_getbenefits
Provider route: GET /eor/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["eorHiring"]["getBenefits"]>[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.eorHiring.getBenefits(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_hiring.get_benefits(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.country_code | string | Required within parent | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query.work_visa | boolean | Required within parent | |
query.work_hours_per_week | number | Required within parent | Format: double Maximum: 168 Minimum: 0 |
query.employment_type | string | Required within parent | One of: Full-time, Part-time |
query.team_id | string | Required within parent | Format: uuid |
query.legal_entity_id | string | Required within parent | Format: uuid |
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 by Country — 200 response body |
Referenced models: Retrieve Benefits by Country — 200 response body
Schemas
Section titled “Schemas”Retrieve Benefits by Country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item |
Referenced models: Retrieve Benefits by Country — 200 response body — data item
Retrieve Benefits by Country — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | The description of the benefit. |
is_discriminatory | boolean | Required within parent | Indicates if the benefit is discriminatory. |
is_mandatory | boolean | Required within parent | Indicates if the benefit is mandatory. |
name | string | Required within parent | The name of the benefit. |
providers | array | Required within parent | |
providers[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item |
Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item
Retrieve Benefits by Country — 200 response body — data item providers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item attachments item |
client_info | JSON | Optional | |
client_info (anyOf 1) | string | Alternative | Client information. |
client_info (anyOf 2) | null | Alternative | Client information. |
contribution_options | array | Required within parent | |
contribution_options[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item contribution options item |
country | string | Required within parent | Country code. |
currency | string | Required within parent | Currency. |
employee_info | JSON | Optional | |
employee_info (anyOf 1) | string | Alternative | Employee information. |
employee_info (anyOf 2) | null | Alternative | Employee information. |
home_page_url | string | Required within parent | The home page URL of the benefit provider. |
id | string | Required within parent | ID of the benefit provider. Format: uuid |
is_unisure | boolean | Required within parent | Indicates if Unisure. |
max_contribution | JSON | Optional | |
max_contribution (anyOf 1) | JSON | Alternative | |
max_contribution (anyOf 1) (anyOf 1) | number | Alternative | Maximum contribution. Format: double |
max_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_contribution (anyOf 2) | null | Alternative | Maximum contribution. Format: double |
min_contribution | JSON | Optional | |
min_contribution (anyOf 1) | JSON | Alternative | |
min_contribution (anyOf 1) (anyOf 1) | number | Alternative | Minimum contribution. Format: double |
min_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_contribution (anyOf 2) | null | Alternative | Minimum contribution. Format: double |
name | string | Required within parent | The name of the benefit provider. |
plans | array | Required within parent | |
plans[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item plans item |
type | string | Required within parent | Benefit type. |
Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item attachments item, Retrieve Benefits by Country — 200 response body — data item providers item contribution options item, Retrieve Benefits by Country — 200 response body — data item providers item plans item
Retrieve Benefits by Country — 200 response body — data item providers item attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique ID of the attachment. |
label | string | Required within parent | The label of the attachment. |
url | string | Required within parent | The url of the attachment. |
Retrieve Benefits by Country — 200 response body — data item providers item contribution options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Amount. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique ID of the contribution. |
Retrieve Benefits by Country — 200 response body — data item providers item plans item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item attachments item |
id | string | Required within parent | The unique ID of the plan. |
name | string | Required within parent | The name of the plan. |
price | JSON | Required within parent | |
price (anyOf 1) | number | Alternative | The price of the plan. Format: double |
price (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item attachments item
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorhiring_getbenefits. Catalog operation: eorhiring_getbenefits. 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: ["benefits:read"]
Pinned headers: {"X-Version": "2026-01-01"}