ResourceProducts
Search ResourceProducts
Search and list ResourceProduct records with filtering, sorting, and pagination.
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
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the resource linked to this record.
Filter by resource name.
Filter by iD of the product linked to this record.
Filter by product name.
Filter by product price.
Filter by product currency code.
Filter by whether to invoice in minutes.
Filter by whether to request quantity.
Filter by whether the resource product is visible.
Filter by price override.
Range Filters
Filter by product price greater than or equal to this value.
Filter by product price less than or equal to this value.
Filter by price override greater than or equal to this value.
Filter by price override less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
The list of ResourceProduct records matching the query. See the Get one ResourceProduct endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search ResourceProducts