A GET to the /profiles/{profileId}/benefits endpoint allows your application to retrieve all Benefits records associated with a Profile.
Browse a profiles available benefits. Similar to Browse Profile Claimable Benefits however this will only showed Issued benefits against a profile.
Filtering Benefits
Omneo allows filter parameters to be appended to the request URL.
These filters allow developers to refine the results returned in the response.
This saves developers from filtering all results on their front end.
Filters are available on the following attributes:
'benefit_definition_id',
'expires_at',
'issued_at',
'meta',
'external_id',
'timezone',
'claimed_at',
'redeem_code_pos',
'redeem_code_online'
Let's imagine we only want to display benefits with the tag "demo"
We can append filter parameters to our original endpoint as below:
{{baseUrl}}/profiles/{profileId}/benefits?tags[]=demo
where ?tags[]=demo results in the API returning only eligible benefits, with a tag of "demo"
We can even go one step further an add advanced filters to identify specific attributes such as:
?filter[benefit_definition_id]=3
Multiple filters can be used by separating the requests with &
Search for multiple tags:
?tags[]=csv&tags[]=download
Multiple filters at once:
?filter[claimed_at]=2020-10-10&tags[]=download
Logical operators can also be used in filters:
?filter[expires_at][lte]=2020-10-01&filter[expires_at][gte]=2020-11-01&tags[]=download
| Operator | Description |
|---|---|
| ne | Not Equal != |
| gt | Greater Than > |
| gte | Greater Than or Equal To >= |
| lt | Less Than < |
| lte | Less Than or Equal To <= |