Retrieve Benefits for Employee

GET

/eor/worker/benefits

GET

/rest/eor/worker/benefits

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

{
  "data": [
    {
      "benefits": [
        {
          "name": "Healthcare",
          "type": "HEALTHCARE",
          "status": "ENROLLED",
          "description": "Ensure the employee is covered by a healthcare option.",
          "enrollment_details": {
            "selected_plan": {
              "id": "c6f6fa50-badf-4950-88ee-2849e76aac8c",
              "name": "Gold",
              "attachments": [
                {
                  "id": "ce022a6d-c24b-48c5-a1a7-ac91e85035f2",
                  "url": "[https://www.provider-a.com/attachments/Canada_Benefits.pdf](https://www.provider-a.com/attachments/Canada_Benefits.pdf)",
                  "label": "Canada_Benefits.pdf"
                }
              ]
            },
            "selected_provider": {
              "id": "a8cbeb12-32e3-44e3-3e1d-2a41c014d0b4",
              "name": "ManuLife",
              "attachments": [
                {
                  "id": "ce022a6d-c24b-48c5-a1a7-ac91e85035f2",
                  "url": "[https://www.provider-a.com/attachments/Canada_Benefits.pdf](https://www.provider-a.com/attachments/Canada_Benefits.pdf)",
                  "label": "Canada_Benefits.pdf"
                }
              ],
              "home_page_url": "[https://wwwec7.manulife.com/signin/#benefits](https://wwwec7.manulife.com/signin/#benefits)",
              "is_unisure": true
            },
            "current_cycle_plan_cost": 100,
            "current_cycle_employer_contribution": 50
          },
          "organization_selection": {
            "selected_plan": {
              "id": "c6f6fa50-badf-4950-88ee-2849e76aac8c",
              "name": "Gold",
              "attachments": [
                {
                  "id": "ce022a6d-c24b-48c5-a1a7-ac91e85035f2",
                  "url": "[https://www.provider-a.com/attachments/Canada_Benefits.pdf](https://www.provider-a.com/attachments/Canada_Benefits.pdf)",
                  "label": "Canada_Benefits.pdf"
                }
              ]
            },
            "selected_provider": {
              "id": "f8cbeb32-14e3-44e3-3e1d-2a41c014d0b4",
              "name": "ManuLife",
              "attachments": [
                {
                  "id": "ce022a6d-c24b-48c5-a1a7-ac91e85035f2",
                  "url": "[https://www.provider-a.com/attachments/Canada_Benefits.pdf](https://www.provider-a.com/attachments/Canada_Benefits.pdf)",
                  "label": "Canada_Benefits.pdf"
                }
              ],
              "home_page_url": "[https://wwwec7.manulife.com/signin/#benefits](https://wwwec7.manulife.com/signin/#benefits)",
              "is_unisure": true
            }
          },
          "id": "5f4d1f3f-4b3b-4b1e-8f4f-3b1f4f1b3b4b",
          "end_date": "2025-12-31",
          "plan_url": "https://plan.example",
          "contract_type": "EOR",
          "provider_name": "ManuLife",
          "coverage_group": "EMPLOYEE",
          "effective_date": "2025-02-01",
          "benefit_type_code": "HEALTHCARE",
          "enrollment_status": "AWAITING_ENROLLMENT",
          "enrollment_window": {
            "ends_at": "2025-01-31",
            "trigger": "open_enrollment",
            "starts_at": "2025-01-01"
          },
          "provider_website_url": "https://provider.example",
          "employee_contribution": {
            "type": "FIXED_AMOUNT",
            "value": "1.23",
            "amount": 100,
            "currency": "USD",
            "frequency": "MONTHLY"
          },
          "employer_contribution": {
            "type": "FIXED_AMOUNT",
            "value": 50,
            "amount": 50,
            "currency": "USD",
            "frequency": "MONTHLY"
          }
        }
      ],
      "currency": "USD",
      "contract_id": "m7yg6zp"
    }
  ]
}

Returns the benefits for the authenticated employee. The employee identity is inferred from the auth token, so this endpoint must be called with an employee-scoped token rather than a client token.

Token scopes: benefits: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/

Response

Successful operation.

datalist of objects

List of contracts with their associated benefits. An employee may have benefits across multiple contracts if they have more than one active engagement.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error