Skip to main content
GET
/
v3
/
profiles
/
{profile}
/
benefits
/
claimable
Browse Profile Claimable Benefits
curl --request GET \
  --url http://localhost/api/v3/profiles/{profile}/benefits/claimable
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "region_id": "<string>",
      "region": {
        "id": "<string>",
        "name": "<string>",
        "handle": "<string>"
      },
      "currency": "<string>",
      "period": "<string>",
      "description": "<string>",
      "internal_notes": "<string>",
      "meta": "<string>",
      "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": "<string>",
      "is_extendable": "<string>",
      "is_assignable": "<string>",
      "is_reassignable": "<string>",
      "is_published": "<string>",
      "is_archived": "<string>",
      "tags": [
        "<string>"
      ],
      "is_claimable": "<string>",
      "max_global_redemptions": "<string>",
      "total_global_redemptions_remaining": "<string>",
      "total_global_redemptions": "<string>",
      "claim_period_start_at": "<string>",
      "claim_period_end_at": "<string>",
      "claim_condition": "<string>",
      "is_reclaimable": "<string>",
      "notify_schedule_offset": "<string>",
      "notify_issue_offset_days": "<string>",
      "notify_issue_offset_hour": "<string>",
      "notify_remind_offset_days": "<string>",
      "notify_remind_offset_hour": "<string>",
      "notify_extend_offset_days": "<string>",
      "notify_extend_offset_hour": "<string>",
      "remind_target_id": "<string>",
      "extend_target_id": "<string>",
      "issue_target_id": "<string>",
      "end_at": "<string>",
      "total_allocations": null,
      "total_allocations_remaining": null,
      "force_allocation": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "claim_timeframe": "<string>",
      "view_condition": "<string>",
      "allow_user_redeem": "<string>",
      "total_global_created": "<string>",
      "same_campaign_count": "<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 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