Search docs ⌘K
esc
Type to search across all documentation pages
Booking

Resources

Manage bookable resources such as rooms, staff members, or equipment. Resources are the entities against which availability and bookings are tracked.

Create a resource

POST
/modules/booking/resources
booking:write

Create a bookable resource.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/booking/resources \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"example"}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
name required
string
1–256 chars
type
string
values: room, table, staff, equipment, generic
description
string
max 2000 chars
capacity
integer
range ≥1 .. ≤10000
duration_min_minutes
integer
range ≥1 .. ≤1440
duration_max_minutes
integer
range ≥1 .. ≤1440
duration_default_minutes
integer
range ≥1 .. ≤1440
enabled
boolean
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

List resources

GET
/modules/booking/resources
booking:read

List bookable resources.

curl
curl https://api.saasignal.saastemly.com/modules/booking/resources \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
type
string
enabled
boolean
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get a resource

GET
/modules/booking/resources/{resource_id}
booking:read

Retrieve a single resource.

curl
curl https://api.saasignal.saastemly.com/modules/booking/resources/{resource_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
resource_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Update a resource

PATCH
/modules/booking/resources/{resource_id}
booking:write

Update a bookable resource.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/booking/resources/{resource_id} \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
resource_id required
string
Body field
Type
Description
name
string
1–256 chars
type
string
values: room, table, staff, equipment, generic
description
mixed
capacity
integer
range ≥1 .. ≤10000
duration_min_minutes
mixed
duration_max_minutes
mixed
duration_default_minutes
mixed
enabled
boolean
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Delete a resource

DELETE
/modules/booking/resources/{resource_id}
booking:admin

Permanently remove a resource.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/booking/resources/{resource_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
resource_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited