For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeel Home
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
OverviewPlatformEmployer of RecordContractorsGlobal PayrollHREmbeddedDeel ITAPI ReferenceChangelog
  • Resources
    • Blog
    • Community
    • API spec
  • Endpoints
      • POSTCreate a direct employee
      • POSTCreate a person without a contract
      • GETGet my current personal profile
      • GETList of People
      • GETRetrieve a single person
      • PUTUpdate working location
    • PATCHProfiles
LogoLogo
SupportDeel Home
EndpointsPeople

Retrieve a single person

GET
/people/:hris_profile_id
GET
/rest/v2/people/:hris_profile_id
$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
1{
2  "data": {
3    "id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
4    "state": "Active",
5    "emails": [
6      {
7        "type": "work",
8        "value": "work.email@example.com"
9      }
10    ],
11    "country": "USA",
12    "timezone": "EST",
13    "addresses": [
14      {
15        "region": "CO",
16        "country": "US",
17        "locality": "Denver",
18        "postalCode": "44000",
19        "streetAddress": "Deel Street 500"
20      }
21    ],
22    "full_name": "John Doe",
23    "job_title": "Access Field Technician",
24    "last_name": "Doe",
25    "seniority": "Junior (Individual Contributor Level 1)",
26    "worker_id": "123",
27    "birth_date": "1990-01-01T00:00:00.000Z",
28    "created_at": "2023-03-21T10:27:25.950Z",
29    "department": {
30      "id": "00000000-0000-0000-0000-000000000000",
31      "name": "Delivery team",
32      "parent": "Research and Development"
33    },
34    "first_name": "John",
35    "start_date": "2023-03-20",
36    "updated_at": "2022-05-24T09:38:46.235Z",
37    "employments": [
38      {
39        "id": "mzj524j",
40        "name": "Khizar Naeem",
41        "team": {
42          "id": "00000000-0000-0000-0000-000000000000",
43          "name": "Delivery team"
44        },
45        "email": "some@example.com",
46        "state": "Active",
47        "country": "USA",
48        "payment": {
49          "rate": 100,
50          "scale": "hourly",
51          "currency": "USD",
52          "contract_name": "Contract 1"
53        },
54        "is_ended": false,
55        "timezone": "EST",
56        "job_title": "Access Field Technician",
57        "seniority": "Junior (Individual Contributor Level 1)",
58        "start_date": "2023-03-20",
59        "work_email": "work.email@example.com",
60        "hiring_type": "contractor",
61        "hiring_status": "onboarding",
62        "completion_date": "2023-06-20T00:00:00.000Z",
63        "contract_status": "waiting_for_client_sign",
64        "voluntarily_left": true,
65        "contract_coverage": "is_shielded",
66        "new_hiring_status": "onboarding_overdue",
67        "client_legal_entity": {
68          "id": "00000000-0000-0000-0000-000000000000",
69          "name": "Acme Corporation"
70        },
71        "has_eor_termination": true,
72        "contract_is_archived": false,
73        "termination_last_day": "2023-03-21T10:27:25.950Z",
74        "contract_has_contractor": true,
75        "is_user_contract_deleted": false,
76        "hris_direct_employee_invitation": {
77          "oid": "rJ7PUDgbp9L6",
78          "status": "DISABLED",
79          "send_at": "2023-03-21T10:27:25.950Z",
80          "timezone": "EST"
81        }
82      }
83    ],
84    "external_id": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
85    "hiring_type": "contractor",
86    "hiring_status": "onboarding",
87    "nationalities": [
88      "American"
89    ],
90    "work_location": "Remote",
91    "direct_manager": {
92      "id": "642b0547-9d80-4d35-a085-fd977ef209ef",
93      "last_name": "John",
94      "worker_id": 30,
95      "first_name": "Doe",
96      "work_email": "john.doe@example.com"
97    },
98    "direct_reports": [
99      {
100        "id": "642b0547-9d80-4d35-a085-fd977ef209ef",
101        "last_name": "John",
102        "first_name": "Doe",
103        "work_email": "john.doe@example.com"
104      }
105    ],
106    "completion_date": "2023-06-20T00:00:00.000Z",
107    "new_hiring_status": "onboarding_overdue",
108    "additional_details": [
109      {
110        "type": "socialSecurity",
111        "value": "123-12-1234",
112        "country": "US"
113      }
114    ],
115    "client_legal_entity": {
116      "id": "00000000-0000-0000-0000-000000000000",
117      "name": "Acme Corporation"
118    },
119    "preferred_last_name": "Doe",
120    "direct_reports_count": 0,
121    "preferred_first_name": "John",
122    "active_worker_termination_status": "IN_PROGRESS",
123    "profile_organizational_structures": [
124      {
125        "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
126        "name": "Department",
127        "teams": [
128          {
129            "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
130            "name": "Team A",
131            "positions": [
132              {
133                "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
134                "role": {
135                  "id": "642b0547-9d80-4d35-a085-dg377ef209d3",
136                  "name": "Role A"
137                },
138                "is_supportive": true
139              }
140            ],
141            "name_hierarchy": "Team A / Team B"
142          }
143        ]
144      }
145    ],
146    "direct_employee_termination_last_day": "2023-03-21",
147    "custom_fields": [
148      {
149        "name": "Job title",
150        "value": "Software Engineer II"
151      }
152    ]
153  }
154}

Returns detailed information about a single person in the organization by their public ID. Returns personal details, employment information, organizational structure, person status, direct manager, custom fields, and related data. Token scopes: people:read

Was this page helpful?
Previous

Update working location

Next
Built with

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error

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.

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

Learn more about authentication