Get employees from organization integrated with external benefits vendor | Deel

curl -G https://api.letsdeel.com/rest/rest/benefits/legal-entities/123456/employees \
     -H "Authorization: Bearer <token>" \
     -d active_contracts=true \
     -d items_per_page=100 \
     -d offset=0

{
  "data": {
    "data": [
      {
        "id": "810d4392-1857-4bd0-98a8-d18ebedbc882",
        "phones": [
          {
            "type": "PERSONAL",
            "dial_code": "+1",
            "phone_number": "1234567890"
          }
        ],
        "status": "active",
        "addresses": [
          {
            "zip": "12345",
            "city": "New York",
            "type": "HOME",
            "state": "NY",
            "street": "123 Main St",
            "country": "US"
          }
        ],
        "contracts": [
          {
            "id": "k628xgg",
            "flsa": "Exempt",
            "status": "active",
            "end_date": "2022-12-31",
            "job_title": "Software Engineer",
            "start_date": "2022-01-01",
            "compensations": [
              {
                "rate": 1000,
                "type": "MAIN",
                "scale": "hourly",
                "currency": "USD",
                "cycle_scale": "hour",
                "variable_compensation_type": "FIXED"
              }
            ],
            "contract_type": "direct_employee",
            "contract_status": "waiting_for_provider_sign",
            "employment_type": "full_time",
            "estimated_week_working_hours": 40
          }
        ],
        "hire_date": "2022-01-01",
        "work_email": "test@example.com",
        "date_of_birth": "1990-01-01",
        "marital_status": "Single",
        "personal_email": "test2@example.com",
        "document_number": "123456789",
        "legal_last_name": "Doe",
        "legal_first_name": "John",
        "legal_middle_name": "Doe",
        "takes_owners_draw": true,
        "ownership_percentage": 50
      }
    ]
  },
  "page": {
    "offset": 0,
    "total_rows": 100,
    "items_per_page": 100
  }
}

Returns employees belonging to the legal entity that has been integrated with an external benefits vendor. Results can be filtered to include only employees with active contracts.

Token scopes: people: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.deel.training/rest/v2/contracts' \
>   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## 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 curl -X GET 'https://api.deel.training/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

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

Path parameters

legal_entity_idstringRequired

Id from the legal entity to fetch data

Query parameters

active_contractsbooleanOptionalDefaults to true

Fetch only active contracts for employees

items_per_pageintegerOptionalDefaults to 100

Items per page

offsetintegerOptionalDefaults to 0

Items to be skipped when searching

Response

Successful operation.

dataobject

pageobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'