Skip to main content
GET
/
v1
/
products
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

​
category
enum<string>

Filter products by category. BOOKING for space reservation products, ADDITIONAL for supplementary services.

Available options:
booking,
additional
​
ids
string[]

Comma-separated list of product IDs to filter by. When provided, only products with matching IDs are returned (still paginated).

Example:

"prod_123,prod_456"

​
spaceId
string

Filter products available for a specific space. Returns only products associated with the given space ID.

Example:

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

​
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

Response

Paginated list of products retrieved successfully

​
data
array[]
required

Array of items

​
meta
object
required

Pagination metadata