Actions38
- Bookings Actions
- Customers Actions
- Agents Actions
- Services Actions
- Payments Actions
- Orders Actions
- Coupons Actions
- Locations Actions
- Availability Actions
Coupons → Get All
AI-generatedSummary
Retrieve a list of coupons from the Latepoint system, optionally applying predefined filters or additional JSON-based filters, with support for pagination and sorting.
Inputs
- Use Filters — Enable predefined filter fields such as coupon code, status, discount type, discount value ranges, validity dates, usage limits, search, sort parameters, and whether to include metadata.
- Filters — When Use Filters is enabled, specify various filter criteria to narrow down the retrieved coupons, including coupon code, status (active, inactive, expired), discount type (fixed amount or percentage), minimum and maximum discount values, validity date range, usage limit range, search text, sorting field (ID, code, discount value, valid from, valid until), sorting order, and inclusion of coupon metadata.
- Additional Filters (JSON) — Provide additional arbitrary filter parameters as a JSON object using API parameter names; works independently of Use Filters toggle.
- Return All — Choose whether to retrieve all matching coupons or limit results to a single page.
- Limit — If Return All is false, limit the number of coupons returned per page (range 1-100).
- Page — If Return All is false, specify the page number to retrieve for paginated results.
- Max Pages — If Return All is true, limit the maximum number of pages to fetch; 0 means fetch all pages.
Output shape
a list of coupons matching the specified filters and pagination settings
If Return All is true, the operation fetches and returns multiple pages up to Max Pages limit; each coupon is returned as a separate JSON object. Pagination metadata is included in the raw API response. If Return All is false, only a single page is returned with the specified Limit and Page parameters. If Include Meta is enabled, coupon metadata fields are included in each coupon object.
Examples
Example 1: Fetch all active coupons with at least 10% discount, sorted by discount value descending, returning all pages
Set Use Filters to true, Status filter to Active, Discount Value Min to 10, Sort By to Discount Value, Sort Order to Descending, Return All to true, and Max Pages to 0.
Example 2: Retrieve first 10 coupons with code containing 'SPRING', including metadata
Set Use Filters to true, Coupon Code filter to 'SPRING', Include Meta to true, Return All to false, Limit to 10, Page to 1.