Retrieve Benefits for EOR Contract

GET

/eor/:contract_id/benefits

GET

/rest/eor/:contract_id/benefits

curl https://api.letsdeel.com/rest/eor/mryv8dx/benefits \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "id": "benefit1",
      "name": "Health Insurance",
      "plan": {
        "name": "Gold Plan"
      },
      "provider": {
        "name": "Global Insurance Co."
      },
      "offer_status": "Offered",
      "enrollment_details": {
        "plan": {
          "name": "Gold Plan"
        },
        "status": "Enrolled",
        "standard": {
          "monthly_cost": "180",
          "employee_monthly_contribution": "130"
        },
        "current_cycle": {
          "monthly_cost": "200",
          "employee_monthly_contribution": "150"
        }
      }
    },
    {
      "id": "benefit2",
      "name": "Retirement Plan",
      "plan": {
        "name": "Standard Pension"
      },
      "provider": {
        "name": "Pension Trust"
      },
      "offer_status": "Not offered"
    }
  ]
}

Returns benefits associated with the specified EOR contract.

Token scopes: contracts:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

Deel contract ID.

Response

Successfully retrieved the list of EOR contract benefits.

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error