Products
Search Products
Search and list Product records with filtering, sorting, and pagination.
GET
A Product represents an item that can be sold to customers. Products can be sold via contracts (
ContractProduct entity), added to bookings (BookingProduct entity), or purchased directly (CoworkerProduct entity).
Products support both one-off sales and recurring charges. Recurring charges can be set to daily, weekly, monthly, or yearly frequencies, or charged every time a contract is invoiced. For invoice-linked recurring charges, prefer using ContractProduct to associate the sale directly with a specific contract rather than relying on the customer’s MainContract.
Use AvailableAs to control whether a product can be sold as a one-off purchase, a recurring charge, or both. The SystemProductType field categorises the product (e.g. day pass, credit bundle, booking product, stationery, or other).
Products can optionally track stock levels, be restricted to specific pricing plans (tariffs), and be limited to members or contacts only.
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 Product-List role.Enums
eProductType — SystemProductType values
eProductType — SystemProductType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | DayPass |
| 2 | CreditBundle |
| 3 | Stationery |
| 4 | BookingFeature |
| 5 | BookingProducts |
| 99 | Other |
eRecurrentProductOptions — AvailableAs values
eRecurrentProductOptions — AvailableAs values
| Value | Name |
|---|---|
| 0 | None |
| 1 | RecurrentOrOneOff |
| 2 | OnlyRecurrent |
| 3 | OnlyOneOff |
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.
1 for ascending, -1 for descending.Filters
Filter by Business Id.
Filter by business name.
Filter by product name.
Filter by category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other.
Filter by product description.
Filter by custom text shown on the invoice line instead of the product name.
Filter by sKU code.
Filter by tags.
Filter by display order.
Filter by product price.
Filter by whether the product is visible to customers on the members portal and mobile app.
Filter by sync to Square.
Filter by Currency Id.
Filter by currency code.
Filter by Tax Rate Id.
Filter by Reduced Tax Rate Id.
Filter by Exempt Tax Rate Id.
Filter by Financial Account Id.
Filter by controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff).
Filter by restrict purchase to contacts (customers without an active contract).
Filter by restrict purchase to customers with an active contract (members).
Filter by whether the product is archived. Archived products cannot be sold but existing charges remain active.
Filter by mark the product as featured or highlighted.
Filter by enable stock tracking for this product. When enabled, each sale reduces the stock count.
Filter by allow sales to continue even when stock reaches zero.
Filter by current stock level.
Filter by stock level at which a low-stock alert is triggered.
Filter by whether to pro-rate the price when the product is added or removed part-way through a billing period.
Filter by Image File Name.
Filter by New Image Url.
Filter by Clear Image File.
Filter by whether to invoice the customer directly rather than their company or team.
Filter by sync to NexKiosk.
Filter by automatically create a delivery record for the customer when this product is purchased.
Range Filters
Filter by display order greater than or equal to this value.
Filter by display order less than or equal to this value.
Filter by product price greater than or equal to this value.
Filter by product price less than or equal to this value.
Filter by current stock level greater than or equal to this value.
Filter by current stock level less than or equal to this value.
Filter by stock level at which a low-stock alert is triggered greater than or equal to this value.
Filter by stock level at which a low-stock alert is triggered 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 Name
Range filters
Response
200
The list of Product records matching the query. See the Get one Product 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 (
1 = 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