Get an order

Get an order

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

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

fetch('https://api.jobhandy.io/v1/orders/{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/orders/{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": "69eb125feddfff1d13676751",
  "status": "approved",
  "employee": "68a000000000000000000001",
  "orderNumber": 10495,
  "createdAt": "2026-07-01T10:00:00.000Z",
  "updatedAt": "2026-07-02T12:15:00.000Z",
  "products": [
    {
      "id": "69eb125feddfff1d13676761",
      "label": "Example Smartphone, 256 GB, Black, New",
      "model": "Example Smartphone",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "smartphones",
      "grossAmount": "34.99",
      "netAmount": "29.4034",
      "service": false,
      "grossService": null,
      "netService": null,
      "isAccessory": false
    },
    {
      "id": "69eb125feddfff1d13676762",
      "label": "Example Protective Case",
      "model": "Example Protective Case",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "accessories",
      "grossAmount": "3.99",
      "netAmount": "3.3529",
      "service": null,
      "grossService": null,
      "netService": null,
      "isAccessory": true
    }
  ],
  "deliveryAddress": {
    "firstName": "Alex",
    "lastName": "Morgan",
    "street": "Example Street 12",
    "postalCode": "50667",
    "city": "Cologne",
    "countryCode": "DE"
  },
  "contractDurationInMonths": 24,
  "contractStartDate": "2026-08-01T00:00:00.000Z",
  "contractEndDate": "2028-07-31T23:59:59.999Z",
  "attachments": [
    {
      "id": "contract.10495.1",
      "type": "nuev"
    },
    {
      "id": "contract.10495.2",
      "type": "emv"
    }
  ],
  "hrHistory": {
    "approvedBy": null,
    "approvedAt": "2026-07-02T12:15:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "requestedAt": "2026-07-01T10:00:00.000Z",
    "decisionBy": null
  }
}

GET

https://api.jobhandy.io/v1

orders

{id}

Get an order

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

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

fetch('https://api.jobhandy.io/v1/orders/{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/orders/{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": "69eb125feddfff1d13676751",
  "status": "approved",
  "employee": "68a000000000000000000001",
  "orderNumber": 10495,
  "createdAt": "2026-07-01T10:00:00.000Z",
  "updatedAt": "2026-07-02T12:15:00.000Z",
  "products": [
    {
      "id": "69eb125feddfff1d13676761",
      "label": "Example Smartphone, 256 GB, Black, New",
      "model": "Example Smartphone",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "smartphones",
      "grossAmount": "34.99",
      "netAmount": "29.4034",
      "service": false,
      "grossService": null,
      "netService": null,
      "isAccessory": false
    },
    {
      "id": "69eb125feddfff1d13676762",
      "label": "Example Protective Case",
      "model": "Example Protective Case",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "accessories",
      "grossAmount": "3.99",
      "netAmount": "3.3529",
      "service": null,
      "grossService": null,
      "netService": null,
      "isAccessory": true
    }
  ],
  "deliveryAddress": {
    "firstName": "Alex",
    "lastName": "Morgan",
    "street": "Example Street 12",
    "postalCode": "50667",
    "city": "Cologne",
    "countryCode": "DE"
  },
  "contractDurationInMonths": 24,
  "contractStartDate": "2026-08-01T00:00:00.000Z",
  "contractEndDate": "2028-07-31T23:59:59.999Z",
  "attachments": [
    {
      "id": "contract.10495.1",
      "type": "nuev"
    },
    {
      "id": "contract.10495.2",
      "type": "emv"
    }
  ],
  "hrHistory": {
    "approvedBy": null,
    "approvedAt": "2026-07-02T12:15:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "requestedAt": "2026-07-01T10:00:00.000Z",
    "decisionBy": null
  }
}

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 order if it is in the API key’s scope.

Re-read immediately before a decision and inspect products, employee, contract fields, status, and attachments.

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

Order ID.

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

Example:

"69eb125feddfff1d13676751"

Response

The requested order.

Order details.

string

required

read-only

Unique order identifier.

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

Example:

"69eb125feddfff1d13676751"

status

enum<string>

required

read-only

Current order lifecycle status. Values are case-sensitive.

Available options:

under_review,

rejected,

approved,

active,

archived,

withdrawn

Minimum string length: 1

Example:

"approved"

employee

string

required

Identifier of the employee who placed or owns the order.

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

Example:

"68a000000000000000000001"

orderNumber

integer

required

read-only

Human-readable numeric order number.

Must be a multiple of 1

Example:

10495

createdAt

string<date-time>

required

read-only

UTC timestamp at which the order was created.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-01T10:00:00.000Z"

updatedAt

string<date-time>

required

read-only

UTC timestamp of the latest order update.

Minimum string length: 1

Pattern: Z$

Example:

"2026-07-02T12:15:00.000Z"

products

object[]

required

Products and accessories included in the order.

Show child attributes

deliveryAddress

object | null

required

nullable

Delivery address for the order, or null when no delivery address is available.

Show child attributes

Example:

{
  "firstName": "Alex",
  "lastName": "Morgan",
  "street": "Example Street 12",
  "postalCode": "50667",
  "city": "Cologne",
  "countryCode": "DE"
}

hrHistory

object

required

HR review request and decision history.

Show child attributes

Example:

{
  "approvedBy": null,
  "approvedAt": "2026-07-02T12:15:00.000Z",
  "rejectedBy": null,
  "rejectedAt": null,
  "requestedAt": "2026-07-01T10:05:00.000Z",
  "decisionBy": null
}

contractDurationInMonths

number | null

required

nullable

Contract duration in whole months, or null when not determined.

Must be a multiple of 1

Example:

24

contractStartDate

string<date-time> | null

required

nullable

UTC contract start date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Example:

"2026-08-01T00:00:00.000Z"

contractEndDate

string<date-time> | null

required

nullable

UTC contract end date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Example:

"2028-07-31T23:59:59.999Z"

attachments

object[]

required

Order contract documents available through the order attachment download endpoint.

Show child attributes

Last modified on August 27, 2026

Overview

Data Models

Specification

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