Get employees from organization integrated with external benefits vendor | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/benefits/legal-entities/123456/employees"
querystring = {"active_contracts":"true","items_per_page":"100","offset":"0"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "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
  }
}

Get employees from organization integrated with external benefits vendor Token scopes: people:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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 or null

pageobject or null

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication