Get employee from organization integrated with external benefits vendor | Deel

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

{
  "id": "123456",
  "phones": [
    {
      "type": "mobile",
      "dial_code": "+1",
      "phone_number": "5555555555"
    }
  ],
  "status": "active",
  "addresses": [
    {
      "zip": "12345",
      "city": "New York",
      "type": "home",
      "state": "NY",
      "street": "123 Main St",
      "country": "US"
    }
  ],
  "contracts": [
    {
      "id": "123456",
      "flsa": true,
      "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",
      "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": "Common Law",
  "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
}

Get employee from organization integrated with external benefits vendor 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.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -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.letsdeel.com/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

idstringRequired

Id from the legal entity to fetch data

employee_idstringRequired

Employee id from the legal entity to fetch data

Query parameters

active_contractsbooleanOptionalDefaults to true

Fetch only active contracts for employees

Response

Successful operation.

idstring

Unique identifier for the employee.

phoneslist of objects

List of phone numbers associated with the employee.

statusstring

The employee status given his contracts.

addresseslist of objects

List of addresses associated with the employee.

contractslist of objects

List of contracts associated with the employee.

hire_datestring or null

Employee date of first contract.

work_emailstring or null

Employee work email address.

date_of_birthstring or null

Employee date of birth.

marital_statusenum

The marital status of the employee.

personal_emailstring or null

Employee personal email address.

document_numberstring

Document number of employee identification document.

legal_last_namestring

Employee legal last name.

legal_first_namestring

Employee legal first name.

legal_middle_namestring or null

Employee legal middle name.

takes_owners_drawboolean

Indicates if the employee takes an owner draw.

ownership_percentagedouble

The percentage of business ownership by the employee.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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