Tool to retrieve a list of coupons. Use when you need to list or search for discount coupons with pagination and filtering.
sortstringSort order for the results. Use field name optionally prefixed with '-' for descending order (e.g., 'name' or '-created_at').
fieldsarrayList of specific fields to include in the response instead of default fields.
includestringComma-separated list of relationships to sideload.
filter_idstringFilter by coupon ID using exact match.
page_sizestringThe number of items per page.
filter_codestringFilter by coupon code.
page_numberstringThe page number to request for pagination.
filter_archivedstringFilter by archived status.
filter_created_atstringFilter by creation timestamp.
filter_percentagestringFilter by percentage value.
filter_updated_atstringFilter by last update timestamp.
filter_archived_atstringFilter by archived timestamp.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.