List of People | Deel | Documentation

import requests
url = "https://api.letsdeel.com/rest/v2/people"
querystring = {"offset":"150","limit":"50","search":"John Doe","teams":"[\"00000000-0000-0000-0000-000000000000\",\"642b0547-9d80-4d35-a085-fd977ef209ef\"]","fields":"[\"first_name\",\"last_name\",\"email\"]","sort_by":"hiring_status","sort_order":"asc","hiring_statuses":"[\"active\",\"onboarded\"]","band_placements":"[\"ABOVE\",\"WITHIN\"]","comparative_ratios_from":"1.1","comparative_ratios_to":"1.1","hiring_types":"[\"eor\",\"contractor\"]"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "data": [
    {
      "id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
      "state": "Active",
      "emails": [
        {
          "type": "work",
          "value": "work.email@example.com"
        }
      ],
      "country": "USA",
      "is_pwac": false,
      "timezone": "EST",
      "addresses": [
        {
          "region": "CO",
          "country": "US",
          "locality": "Denver",
          "postalCode": "44000",
          "streetAddress": "Deel Street 500"
        }
      ],
      "full_name": "John Doe",
      "job_title": "Access Field Technician",
      "last_name": "Doe",
      "seniority": "Junior (Individual Contributor Level 1)",
      "worker_id": "123",
      "birth_date": "1990-01-01T00:00:00.000Z",
      "created_at": "2023-03-21T10:27:25.950Z",
      "department": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Delivery team",
        "parent": "Research and Development"
      },
      "first_name": "John",
      "start_date": "2023-03-20",
      "updated_at": "2022-05-24T09:38:46.235Z",
      "employments": [
        {
          "id": "mzj524j",
          "name": "Khizar Naeem",
          "team": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Engineering Team"
          },
          "email": "some@example.com",
          "state": "Active",
          "country": "USA",
          "payment": {
            "rate": 100.5,
            "scale": "hourly",
            "currency": "USD",
            "contract_name": "Full-time Employment Contract"
          },
          "is_ended": false,
          "timezone": "EST",
          "job_title": "Access Field Technician",
          "seniority": "Junior (Individual Contributor Level 1)",
          "start_date": "2023-03-20",
          "work_email": "work.email@example.com",
          "hiring_type": "contractor",
          "hiring_status": "onboarding",
          "band_placement": "ABOVE",
          "completion_date": "2023-06-20T00:00:00.000Z",
          "contract_status": "waiting_for_client_sign",
          "voluntarily_left": true,
          "comparative_ratio": 1.1,
          "contract_coverage": "is_premium",
          "new_hiring_status": "onboarding_overdue",
          "client_legal_entity": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Acme Corporation"
          },
          "has_eor_termination": true,
          "compensation_band_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
          "contract_is_archived": false,
          "termination_last_day": "2023-03-21T10:27:25.950Z",
          "contract_has_contractor": true,
          "is_user_contract_deleted": false,
          "hris_direct_employee_invitation": {
            "oid": "rJ7PUDgbp9L6",
            "status": "DISABLED",
            "send_at": "2023-03-21T10:27:25.950Z",
            "timezone": "EST"
          }
        }
      ],
      "external_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
      "hiring_type": "contractor",
      "hiring_status": "onboarding",
      "nationalities": [
        "American"
      ],
      "work_location": "Remote",
      "direct_manager": {
        "id": "642b0547-9d80-4d35-a085-fd977ef209ef",
        "last_name": "John",
        "worker_id": 30,
        "first_name": "Doe",
        "work_email": "john.doe@example.com"
      },
      "direct_reports": [
        {
          "id": "642b0547-9d80-4d35-a085-fd977ef209ef",
          "last_name": "John",
          "first_name": "Doe",
          "work_email": "john.doe@example.com"
        }
      ],
      "completion_date": "2023-06-20T00:00:00.000Z",
      "new_hiring_status": "onboarding_overdue",
      "client_legal_entity": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Acme Corporation"
      },
      "preferred_last_name": "Doe",
      "direct_reports_count": 0,
      "preferred_first_name": "John",
      "hris_organization_user_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
      "active_worker_termination_status": "IN_PROGRESS",
      "direct_employee_termination_last_day": "2023-03-21T10:27:25.950Z"
    }
  ],
  "page": {
    "offset": 1,
    "total_rows": 1.1,
    "items_per_page": 1.1
  }
}

Use this endpoint to retrieve people in your organization for building directories or syncing HR data. Paginate with offset/limit and filter with search, teams, and other query parameters. This operation is non-destructive. 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/

Query parameters

offsetintegerOptional0-999999999Defaults to 0

Return a page of results with given number of records.

limitintegerOptional1-200

Return a page of results with given number of records.

searchstringOptional

Include a contract if by name or contractor name contains given search term.

teamslist of stringsOptional

Filter the results based on the team(group) the users contract is associated with

fieldslist of enumsOptional

Pick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., ‘employments[0].contract_status’) to access nested fields.

sort_byenumOptional

Sort people by given field name.

sort_orderenumOptional

Order direction of results; ascending or descending.

Allowed values:

hiring_statuseslist of enumsOptional

Employee's current hiring status.

band_placementslist of enumsOptional

Employee's current band placement.

Allowed values:

comparative_ratios_fromdoubleOptional

Employee's minimum band placement

comparative_ratios_todoubleOptional

Employee's maximum band placement

hiring_typeslist of enumsOptional

Filter people by hiring types

Response

Successful response

datalist of objects

pageobject or null

Authentication

Authentication

Query parameters

Response

Errors

Authentication