Skip to content
Bookrail

Search is only available in production builds. Try building and previewing the site to test it out locally.

Retrieve a hold

GET
/v1/holds/{id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required

Identifier of the hold.

string

Header Parameters

Section titled “Header Parameters ”
Bookrail-Version

The dated API version to speak. Defaults to 2026-09-01; an unsupported value is a 400.

string
Example
2026-09-01
Bookrail-Actor

Which Bookrail tool the caller is, recorded as actor.via on every event the request writes. A closed list: an unknown value is a 400. Absent means the request declared no tool.

string
Allowed values: mcp cli sdk dashboard

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success.

object
id
required

Identifier of a hold, prefixed with hold_.

string
/^hold_[0-9a-f]{32}$/
Example
hold_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
object
required
string
Allowed values: hold
status
required

Computed, not copied: a hold whose expires_at has passed is expired even while its row still says active.

string
Allowed values: active released expired converted
service_id
required

Identifier of a service, prefixed with svc_.

string
/^svc_[0-9a-f]{32}$/
Example
svc_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
customer_id
required

Identifier of a customer, prefixed with cus_.

string | null
/^cus_[0-9a-f]{32}$/
Example
cus_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
booking_id
required

Identifier of a booking, prefixed with bk_.

string | null
/^bk_[0-9a-f]{32}$/
Example
bk_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
start
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
end
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
duration_minutes
required
integer
quantity
required
integer
timezone
required
string | null
expires_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
price
required

Always null on read: holds has no price column.

object
amount
required
integer
currency
required
string
price_rule
required

Always null on read, for the same reason as price.

object
index
required

Position in service.pricing_rules.

integer
label
required

The rule label, when it has one.

string | null
allocations
required
Array<object>
object
object
required
string
Allowed values: booking_allocation
resource_id
required

Identifier of a resource, prefixed with res_.

string
/^res_[0-9a-f]{32}$/
Example
res_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
role
required
string | null
capacity_used
required
integer
id

Present on a booking allocation, absent on the allocations of a hold.

string
/^ball_[0-9a-f]{32}$/
Example
ball_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
resource
object
id
required

Identifier of a resource, prefixed with res_.

string
/^res_[0-9a-f]{32}$/
Example
res_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
object
required
string
Allowed values: resource
name
required
string
type
required
string
location_id
required

Identifier of a location, prefixed with loc_.

string | null
/^loc_[0-9a-f]{32}$/
Example
loc_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
schedule_id
required

Identifier of a schedule, prefixed with sch_.

string | null
/^sch_[0-9a-f]{32}$/
Example
sch_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
capacity
required
integer
attributes
required
object
key
additional properties
status
required
string
Allowed values: active inactive
tenant_id
required

Optional tenant this object belongs to, for multi-tenant customers.

string | null
metadata
required

Free-form key/value pairs stored with the object and returned untouched.

object
key
additional properties
environment
required

The environment of the API key that created the object.

string
Allowed values: test live
created_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
updated_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
schedule

Present only with expand[]=schedule. null when the resource has none.

object
id
required

Identifier of a schedule, prefixed with sch_.

string
/^sch_[0-9a-f]{32}$/
Example
sch_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
object
required
string
Allowed values: schedule
name
required
string
timezone
required
string | null
rules
required
Array<object>
object
id
required

Identifier of a schedule_rule, prefixed with shr_.

string
/^shr_[0-9a-f]{32}$/
Example
shr_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
object
required
string
Allowed values: schedule_rule
schedule_id
required

Identifier of a schedule, prefixed with sch_.

string
/^sch_[0-9a-f]{32}$/
Example
sch_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
days_of_week
required
Array<integer>
start_time
required
string | null
end_time
required
string | null
valid_from
required
string | null
valid_until
required
string | null
exceptions
required
Array<object>
object
id
required

Identifier of a schedule_exception, prefixed with she_.

string
/^she_[0-9a-f]{32}$/
Example
she_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
object
required
string
Allowed values: schedule_exception
schedule_id
required

Identifier of a schedule, prefixed with sch_.

string
/^sch_[0-9a-f]{32}$/
Example
sch_0198f0c2a1b47e2e9a1c0f4d5e6a7b8c
date
required
string
type
required
string
Allowed values: closed open
start_time
required
string | null
end_time
required
string | null
reason
required
string | null
metadata
required

Free-form key/value pairs stored with the object and returned untouched.

object
key
additional properties
environment
required

The environment of the API key that created the object.

string
Allowed values: test live
created_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
updated_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
metadata
required

Free-form key/value pairs stored with the object and returned untouched.

object
key
additional properties
environment
required

The environment of the API key that created the object.

string
Allowed values: test live
created_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z
updated_at
required

ISO 8601 instant in UTC.

string | null format: date-time
Example
2026-09-08T07:00:00Z

Headers

Section titled “Headers ”
Bookrail-Request-Id
required

Identifier of this request. Quote it to support.

string
Bookrail-Version
required

The API version this response was produced with.

string

400

Section titled “400 ”

Error codes: parameter_invalid, unsupported_api_version.

object
error
required
object
type
required
string
Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal
code
required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string
message
required
string
param

The field or header the error is about, when there is one.

string
doc_url
required
string
request_id
required
string

Headers

Section titled “Headers ”
Bookrail-Request-Id
required

Identifier of this request. Quote it to support.

string
Bookrail-Version
required

The API version this response was produced with.

string

401

Section titled “401 ”

Error codes: invalid_api_key, invalid_authorization_header, missing_api_key, revoked_api_key.

object
error
required
object
type
required
string
Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal
code
required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string
message
required
string
param

The field or header the error is about, when there is one.

string
doc_url
required
string
request_id
required
string

Headers

Section titled “Headers ”
Bookrail-Request-Id
required

Identifier of this request. Quote it to support.

string
Bookrail-Version
required

The API version this response was produced with.

string

404

Section titled “404 ”

Error codes: resource_missing.

object
error
required
object
type
required
string
Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal
code
required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string
message
required
string
param

The field or header the error is about, when there is one.

string
doc_url
required
string
request_id
required
string

Headers

Section titled “Headers ”
Bookrail-Request-Id
required

Identifier of this request. Quote it to support.

string
Bookrail-Version
required

The API version this response was produced with.

string

500

Section titled “500 ”

Error codes: internal_error.

object
error
required
object
type
required
string
Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal
code
required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string
message
required
string
param

The field or header the error is about, when there is one.

string
doc_url
required
string
request_id
required
string

Headers

Section titled “Headers ”
Bookrail-Request-Id
required

Identifier of this request. Quote it to support.

string
Bookrail-Version
required

The API version this response was produced with.

string