Skip to main content
GET
Search ResourceProducts
A ResourceProduct links a product to a resource, enabling products to be offered as add-ons when booking that resource (e.g. catering, AV equipment, room setup).

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ResourceProduct-List role.

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the resource linked to this record.
string
Filter by resource name.
integer
Filter by iD of the product linked to this record.
string
Filter by product name.
number
Filter by product price.
string
Filter by product currency code.
boolean
Filter by whether to invoice in minutes.
boolean
Filter by whether to request quantity.
boolean
Filter by whether the resource product is visible.
number
Filter by price override.

Range Filters

number
Filter by product price greater than or equal to this value.
number
Filter by product price less than or equal to this value.
number
Filter by price override greater than or equal to this value.
number
Filter by price override less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

ResourceProduct[]
The list of ResourceProduct records matching the query. See the Get one ResourceProduct endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response