Skip to main content
GET
/
v1
/
bookings
Error
A valid request URL is required to generate request examples
{
  "data": [
    "<array>"
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalItems": 100,
    "totalPages": 5,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Authorizations

Authorization
string
header
required

OAuth2 authentication for Boseat API

Query Parameters

page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

spaceIds
string[]

Filter bookings by space identifiers. Returns only bookings for the specified spaces. If not provided, returns bookings for all spaces in the organization.

Example:
[
"2d319de5-4700-4099-9353-2a951e67416b",
"0c6f89a1-233b-4c7a-8b85-98f06a90a9f3"
]
customerId
string<uuid>

Filter bookings by customer ID. Returns only bookings made by the specified customer. Useful for retrieving a customer's booking history.

Example:

"a3f1d7d0-ef1d-4b2e-aad2-123456789abc"

Response

Paginated list of bookings retrieved successfully

data
array[]
required

Array of items

meta
object
required

Pagination metadata