Skip to main content

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.

There are two distinct benefit lists available on a profile: benefits already issued to the profile, and benefits the profile is eligible to claim. Both are available as profile-scoped endpoints.

​
Retrieve issued benefits

Returns all active benefits currently assigned to the profile. 
curl -X GET https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/benefits \
  -H "Authorization: Bearer ${TOKEN}"
Use this at POS, in a customer app, or at checkout to show the customer what benefits they currently hold. The response includes benefit instances with their definition details, issued and expiry dates, redemption count, and current status.

​
Retrieve a specific issued benefit

curl -X GET https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/benefits/{benefitId} \
  -H "Authorization: Bearer ${TOKEN}"

​
Retrieve claimable benefits

Returns benefits the profile is eligible to claim but has not yet selected. Claimable benefits are configured with is_claimable: true on the Benefit Definition and may have a claim_condition that limits which profiles see them. 
curl -X GET https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/benefits/claimable \
  -H "Authorization: Bearer ${TOKEN}"
Use this to display a “choose your benefit” selection UI — for example, letting a tier member pick their preferred annual benefit from a list.

​
Claim a benefit

Once a profile selects a claimable benefit, record the claim: 
curl -X POST https://api.[tenant].getomneo.com/api/v3/profiles/{profileId}/benefits/{benefitId}/claim \
  -H "Authorization: Bearer ${TOKEN}"
This moves the benefit from claimable to issued on the profile.