Get an employee

curl --request GET \
  --url https://api.jobhandy.io/v1/employees/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.jobhandy.io/v1/employees/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/employees/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "68a000000000000000000001",
  "email": "alex.morgan@example.com",
  "privateEmail": "alex.morgan.private@example.net",
  "employeeNumber": "EMP-1042",
  "firstName": "Alex",
  "lastName": "Morgan",
  "phoneNumber": "+49 221 5550100",
  "street": "Example Street 12",
  "postalCode": "50667",
  "city": "Cologne",
  "countryCode": "DE",
  "additionalInfo": "Building B, third floor",
  "blocked": false,
  "tenant": "68a000000000000000000010",
  "divisionId": "68920e08eeaea4f2301eecb3",
  "createdAt": "2026-06-01T08:00:00.000Z",
  "updatedAt": "2026-07-15T11:30:00.000Z"
}

GET

https://api.jobhandy.io/v1

employees

{id}

Get an employee

curl --request GET \
  --url https://api.jobhandy.io/v1/employees/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.jobhandy.io/v1/employees/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/employees/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "68a000000000000000000001",
  "email": "alex.morgan@example.com",
  "privateEmail": "alex.morgan.private@example.net",
  "employeeNumber": "EMP-1042",
  "firstName": "Alex",
  "lastName": "Morgan",
  "phoneNumber": "+49 221 5550100",
  "street": "Example Street 12",
  "postalCode": "50667",
  "city": "Cologne",
  "countryCode": "DE",
  "additionalInfo": "Building B, third floor",
  "blocked": false,
  "tenant": "68a000000000000000000010",
  "divisionId": "68920e08eeaea4f2301eecb3",
  "createdAt": "2026-06-01T08:00:00.000Z",
  "updatedAt": "2026-07-15T11:30:00.000Z"
}

At a glance

Property	Behavior
Authentication	Required in X-API-Key
Tenant context	Optional narrowing; resource and references must remain in scope
Dry run	Not supported
Request body	None
Response	JSON
Primary success	`200`
Side effects	None beyond reading or downloading the authorized resource
Retry guidance	Transient read failures are generally safe to retry with bounded backoff

Operational behavior

Returns the employee if it is in the API key’s scope.

A resource outside the API-key scope is not accessible through this operation.

Common errors

Error code	Meaning
`VALIDATION_ERROR`	Schema or business validation failed
`INVALID_REQUEST_ID`	X-Request-ID is not UUID v4 or v7
`INVALID_API_KEY`	Missing, invalid, deleted, or inactive API key
`TENANT_NOT_IN_SCOPE`	Selected tenant is outside API-key scope
`NOT_FOUND`	Resource is absent or not accessible in scope
`NOT_ACCEPTABLE`	Requested response media type is unavailable
`RATE_LIMIT_EXCEEDED`	API-key rate limit was exceeded
`INTERNAL_SERVER_ERROR`	Unexpected server failure

The operation response list and Error handling page are authoritative for complete handling.

Before implementation

Generate and log a new X-Request-ID for the attempt.
Handle every documented response status.
Do not log X-API-Key or unnecessary personal data.
Reconcile current resource state before replaying an ambiguous write.

Related integration guidance

Review the complete process, state, retry, and operational pattern for this operation.

Authorizations

X-API-Key

string

header

required

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Headers

X-Tenant-ID

string

inactive

optional

not sent by default

Narrows the operation to one tenant in the API key's scope. Any referenced or target resource must be accessible through that tenant. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

Pattern: ^[0-9a-fA-F]{24}$

X-Request-ID

string<uuid>

inactive

optional

not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Path Parameters

string

required

Employee ID.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68920e08eeaea4f2301eecb3"

Response

The requested employee.

Employee details.

string

required

read-only

Unique employee identifier.

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68a000000000000000000001"

string<email>

required

Work email address used by the employee account. This field is not editable through the update endpoint.

Example:

"alex.morgan@example.com"

blocked

boolean

required

Whether the employee account is blocked.

Example:

false

tenant

string | null

required

read-only

nullable

Tenant identifier, or null if the employee has no tenant assignment.

Minimum string length: 1

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68a000000000000000000010"

divisionId

string | null

required

nullable

Assigned division identifier, or null when no division is assigned.

Minimum string length: 1

Pattern: ^[0-9a-fA-F]{24}$

Example:

"68920e08eeaea4f2301eecb3"

createdAt

string<date-time>

required

read-only

UTC timestamp at which the employee record was created.

Minimum string length: 1

Pattern: Z$

Example:

"2026-06-01T08:00:00.000Z"

updatedAt

string<date-time>

required

read-only

UTC timestamp of the latest employee update.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-15T11:30:00.000Z"

privateEmail

string | null

nullable

optional

Optional private email address, or null when none is stored.

Example:

"alex.morgan.private@example.net"

employeeNumber

string | null

nullable

optional

Customer-defined personnel or employee number, or null when none is assigned.

Example:

"EMP-1042"

firstName

string | null

nullable

optional

Employee first name, or null when unavailable in an existing record.

Example:

"Alex"

lastName

string | null

nullable

optional

Employee last name, or null when unavailable in an existing record.

Example:

"Morgan"

phoneNumber

string | null

nullable

optional

Employee phone number, or null when none is stored.

Example:

"+49 221 5550100"

street

string | null

nullable

optional

Street and house number, or null when no address is stored.

Example:

"Example Street 12"

postalCode

string | null

nullable

optional

Postal code, or null when no address is stored.

Example:

"50667"

city

string | null

nullable

optional

City, or null when no address is stored.

Example:

"Cologne"

countryCode

string | null

nullable

optional

Uppercase two-character country or territory code, or null when no address is stored.

Example:

"DE"

additionalInfo

string | null

nullable

optional

Additional employee or address information, or null when none is stored.

Example:

"Building B, third floor"

Last modified on August 27, 2026

Overview

Data Models

Specification

Get an employee

At a glance

Operational behavior

Common errors

Before implementation

Related integration guidance

Authorizations

Headers

Path Parameters

Response

​At a glance

​Operational behavior

​Common errors

​Before implementation

Related integration guidance

Authorizations

Headers

Path Parameters

Response

At a glance

Operational behavior

Common errors

Before implementation