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
      • GETGet personal information by id
      • GETGet worker profile by external ID
      • PATCHUpdate personal information
      • PATCHUpdate personal information by external id
    • PATCHProfiles
LogoLogo
SupportDeel Home
EndpointsPersonal Information

Get worker profile by external ID

GET
/people/external/:worker_id/personal
GET
/rest/v2/people/external/:worker_id/personal
$curl https://api.letsdeel.com/rest/v2/people/external/123456/personal \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "externalWorkerId": "123456",
3 "firstName": "Emily",
4 "lastName": "Johnson",
5 "dateOfBirth": "1985-07-23",
6 "email": "emily.johnson@example.com",
7 "phoneNumber": "+1-555-123-4567",
8 "jobTitle": "Senior Software Engineer",
9 "department": "Engineering",
10 "employmentStatus": "Active",
11 "hireDate": "2015-09-01",
12 "location": "New York, NY",
13 "managerId": "78910",
14 "profilePictureUrl": "https://company.example.com/profiles/emily.johnson.jpg"
15}

Retrieves a worker profile record using a system-wide external worker identifier. Token scopes: people:read

Was this page helpful?
Previous

Update personal information

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.

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

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

worker_idstringRequired

System-wide external identifier for a worker record.

Response

Successful response

Errors

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