Skip to main content
GET
Read a hold — its status, its heldUntil, and the supplier time it claims

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project the hold belongs to.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

reservationId
string
required

The reservationId returned by POST /holds.

Minimum string length: 1
Example:

"resv_01kv8p20m1gnqvxl92xln6awk8"

Response

The hold

reservationId
string
required
Example:

"resv_01kv8p20m1gnqvxl92xln6awk8"

status
enum<string>
required
Available options:
HELD,
CONVERTED,
RELEASED
heldUntil
string<date-time>
required

When the hold lapses. Expiry is LAZY — nothing runs at this instant; the hold simply stops blocking. Convert before this time.

Example:

"2026-07-10T12:05:00.000Z"

intervals
object[]
required