Retrieve a single person | Deel

curl -G https://api.letsdeel.com/rest/v2/people/9b9fc43a-a90c-4615-ac50-baf1e314b53e \
     -H "Authorization: Bearer <token>" \
     -d include_custom_fields=true \
     -d include_worker_relations=true

{
  "data": {
    "id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
    "state": "Active",
    "emails": [
      {
        "type": "work",
        "value": "work.email@example.com"
      }
    ],
    "country": "USA",
    "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": "Delivery team"
        },
        "email": "some@example.com",
        "state": "Active",
        "country": "USA",
        "payment": {
          "rate": 100,
          "scale": "hourly",
          "currency": "USD",
          "contract_name": "Contract 1"
        },
        "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",
        "completion_date": "2023-06-20T00:00:00.000Z",
        "contract_status": "waiting_for_client_sign",
        "voluntarily_left": true,
        "contract_coverage": [
          "no_coverage"
        ],
        "new_hiring_status": "onboarding_overdue",
        "client_legal_entity": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Acme Corporation"
        },
        "has_eor_termination": true,
        "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",
    "active_worker_termination_status": "IN_PROGRESS",
    "profile_organizational_structures": [
      {
        "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
        "name": "Department",
        "teams": [
          {
            "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
            "name": "Team A",
            "positions": [
              {
                "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
                "role": {
                  "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
                  "name": "Role A"
                },
                "is_supportive": true
              }
            ],
            "name_hierarchy": "Team A / Team B"
          }
        ]
      }
    ],
    "direct_employee_termination_last_day": "2023-03-21",
    "custom_fields": [
      {
        "name": "Job title",
        "value": "Software Engineer II"
      }
    ]
  }
}

Retrieves detailed information about a single person (employee, contractor, or worker) in the organization by their HRIS profile OID, including personal details, employment information, organizational structure, direct manager and reports, custom fields, and related metadata. 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

hris_profile_idstringRequiredformat: "uuid"

Unique identifier for the person.

Query parameters

include_custom_fieldsbooleanOptional

Include custom fields in the response.

include_worker_relationsbooleanOptional

Include worker relations in the response.

Response

Successful response

dataobject

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication