Skip to main content
GET
/
v3
/
profiles
/
{profile}
/
benefits
Browse Profile Benefits
curl --request GET \
  --url http://localhost/api/v3/profiles/{profile}/benefits
{
  "data": [
    {
      "id": 123,
      "profile_id": "<string>",
      "external_id": "<string>",
      "expires_at": "<string>",
      "issued_at": "<string>",
      "is_expired": "<string>",
      "is_redeemable": "<string>",
      "redemptions_remaining": "<string>",
      "total_global_redemptions_remaining": {},
      "definition": {
        "id": "<string>",
        "name": "<string>",
        "handle": "<string>",
        "region_id": 123,
        "region": {
          "id": 123,
          "name": "<string>",
          "handle": "<string>"
        },
        "currency": "<string>",
        "period": 123,
        "description": "<string>",
        "internal_notes": "<string>",
        "meta": [
          "<unknown>"
        ],
        "short_description": "<string>",
        "long_description": "<string>",
        "terms_conditions": "<string>",
        "earn_instructions": "<string>",
        "redeem_instructions_store": "<string>",
        "redeem_instructions_online": "<string>",
        "redeem_code_pos": "<string>",
        "redeem_code_online": "<string>",
        "icon": "<string>",
        "image_url": "<string>",
        "max_redemptions": 123,
        "is_extendable": true,
        "is_assignable": true,
        "is_reassignable": true,
        "is_published": true,
        "is_archived": true,
        "tags": [
          "<string>"
        ],
        "is_claimable": true,
        "max_global_redemptions": 123,
        "claim_period_start_at": "<string>",
        "claim_period_end_at": "<string>",
        "claim_condition": [
          "<unknown>"
        ],
        "is_reclaimable": true,
        "notify_schedule_offset": 123,
        "notify_issue_offset_days": 123,
        "notify_issue_offset_hour": 123,
        "notify_remind_offset_days": 123,
        "notify_remind_offset_hour": 123,
        "notify_extend_offset_days": 123,
        "notify_extend_offset_hour": 123,
        "remind_target_id": 123,
        "extend_target_id": 123,
        "issue_target_id": 123,
        "end_at": "<string>",
        "total_allocations": null,
        "total_allocations_remaining": null,
        "force_allocation": true,
        "created_at": "<string>",
        "updated_at": "<string>",
        "claim_timeframe": [
          "<unknown>"
        ],
        "view_condition": [
          "<unknown>"
        ],
        "allow_user_redeem": true,
        "same_campaign_count": 123
      },
      "timezone": "<string>",
      "claimed_at": "<string>",
      "meta": [
        "<unknown>"
      ],
      "redeem_code_pos": "<string>",
      "redeem_code_online": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "value": "<string>",
      "combine_meta": [
        "<unknown>"
      ],
      "is_combined": true,
      "extended_at": "<string>",
      "source_id": 123,
      "source_type": "<string>"
    }
  ]
}

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.

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
OperatorDescription
neNot Equal !=
gtGreater Than >
gteGreater Than or Equal To >=
ltLess Than <
lteLess Than or Equal To <=

Path Parameters

profile
string<uuid>
required

The profile ID

Query Parameters

page[size]
string
include_expired
string

Response

Array of Benefit

data
Benefit · object[]
required