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.Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.
{{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 <= |