Search coupons

get

https://{tenant}.onechurchsoftware.com/api/forms/{form}/coupons

Retrieve the discount coupons configured for the given form.

Required permission: Full Read Forms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

form

int32

required

≥ 1

The id of the form.

Query Params

name

string

Return coupons whose name contains the given text.

active

boolean

Whether the coupon is currently active.

auto

boolean

Whether the coupon applies automatically (true) or requires a code (false).

description

string

Return coupons whose description contains the given text.

code

string

Return coupons whose code contains the given text.

discount.start

double

Return coupons discounting at least this amount.

discount.end

double

Return coupons discounting at most this amount.

start.start

date-time

Return coupons becoming valid on or after this date.

start.end

date-time

Return coupons becoming valid on or before this date.

end.start

date-time

Return coupons expiring on or after this date.

end.end

date-time

Return coupons expiring on or before this date.

criteria

string

Comma-delimited list of eligibility criteria ids: 1 = all items, 2 = any item from a given list, 3 = all items from a given list.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found