List benefits
<Warning><Badge color="yellow">BETA endpoint</Badge>
This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.
</Warning>Returns a cursor-paginated list of benefits. Supports filtering by id, name, status, type, and created_at, ordering by created_at, name, and type (prefix with - for descending), and cursor-based pagination. Deleted benefits are excluded. Multiple filters are combined with the junction (AND by default). The same field cannot be ordered both ascending and descending at the same time.
Query parameters
Maximum number of benefits to return. An integer between 1 and 100. Defaults to 10 when omitted.
Ordering of the results. A single field name or an array of field names; prefix with - for descending order. Defaults to -created_at. The same field cannot be used in both ascending and descending order at once.
Pagination cursor returned in the cursor.next field of a previous response. Cursors are bound to the filters and order of the query that produced them.
Field-specific filter conditions, e.g. filters[name][conditions][$contains]=gold. Conditions of multiple fields are combined with the junction.
Response
Cursor-paginated list of benefits