Skip to main content
GET
Browse Profile Claimable Benefits

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

The not_has operator applies to related attributes, which this endpoint does not have.

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-created_at for descending order.

Search attributes

filter[search] runs one partial match term across tags.handle, name, handle, description, campaign, redeem_code_pos, redeem_code_online. A record matches when any one of those attributes contains the term.
Browse claimable benefits against a profile. A claimable benefit is a Benefit Definitions with is_claimable = true that is available to claim. The definition start/end dates must still be valid, and any claim_conditions configured against the definition must validate successfully against the profile.

Path Parameters

profile
string<uuid>
required

The profile ID

Query Parameters

nearest_locations
string

Response

Array of BenefitDefinitionList

data
BenefitDefinitionList · object[]
required