Jump to Content

Guides Help Centre

Home Guides Recipes API Reference Changelog

v3.9.0

Guides Help Centre Contact

API Reference

v3.9.0Home Guides Recipes API Reference Changelog

All

Pages

Start typing to search…

Authentication

Auth
Access Tokens
API Tokens
Delegation Tokens
- Add Delegation Tokenpost
Scopes
- Browse Scopesget

Profiles

Profile Credits
- GET /profiles/{profile}/creditsget
Profile Redemptions
Profile Rewards
Profile Benefits
- POST /profiles/{profile}/benefits/claimpost
- GET /profiles/{profile}/benefits/viewableget
Profile Achievements
- GET /profiles/{profile}/achievements/{definition}/achievement-pointsget
Profile Transactions
Profile Aggregations
- PUT /profiles/{profileId}/aggregationsput
- GET /profiles/{profile}/aggregations/calculateget
Profile Tiers
Profile Connections
- PUT /profiles/{profileId}/connections/{connectionId}put
Profile Addresses
- POST /profiles/{profile}/addresses/upsertpost
Profile Attributes
Profile Identities
Product Lists
- GET /product-lists/searchget
Profile Transaction Items
- GET /profiles/{profile}/transactionitems/list/{type}get
Profile Transaction Products
- GET /profiles/{profile}/transaction-productsget
Profile Resync
- GET /profiles/{profile}/resyncget
Profile Lists
Identities
- GET /identities/search-profile/{identifier}get
Profile Orders
Profile Ledgers
- GET /profiles/{profile}/ledgersget
- GET /profiles/{profile}/ledgers/{ledger}get
Profile Additional Data
Profile Connections
Profile Addresses
Profile Attributes (Comms)
- Read Profile Attributes (Comms)get
- Edit Profile Attributes (Comms)put
Profile Attributes (Appearance)
- Read Profile Attributes (Appearance)get
- Edit Profile Attributes (Appearance)put
Profile Attributes (Dates)
Profile Identities
Profile Attributes (Custom)
Profile Lists
Profiles
Profile Region
Profile Points
- GET /profiles/{profile}/linked_pointsget
Profie Interactions
Profile Batches

Business

Custom Fields
Transactions
Products
Staff
- GET /staff/{staffIdentifier}get
Connections
- PUT /connections/{connectionId}put
List
- GET /list/items/{itemId}/reservationsget
- GET /list/items/{itemId}/reservations/{reservationId}get
Custom Products
Lists
Interactions
Orders
Redemptions
- GET /redemptions/group/{attribute}get
Tiers
Import Jobs
Transaction Items
Products
Product Variants
Locations
Order Items
Organisation Profiles
Staff Profiles
Ratings
Imports
Transactions
Organisations

Configuration

Locations
Roles
- GET /rolesget
- GET /roles/{role}get
Brands
Countries
Currencies
Departments
Rates
Regions
Systems
Tags
Saved Filters
Achievement Definitions
Benefit Definitions
Credit Definitions
Point Definitions
Reward Definitions
Tier Definitions
Connection Definitions
Role Definitions
Statuses
Targets
Webhooks
Triggers
Automations
Settings
Users
Roles
- Browse Rolesget
- Read a Roleget
Permissions
- Browse Permissionsget
- Read a Permissionget
Audits
- Browse Auditsget
- Read an Auditget
Connections

Settings

Tenants
Reminders
Action History
- GET /action-historyget
- GET /action-history/{action_history}get
Audits
Permissions
Settings
- POST /settingspost
- GET /settings/environmentget
Automations
- POST /automations/queries/samplespost
- POST /automations/{automation}/triggerpost
Triggers
- PUT /triggers/{triggerId}put
Webhooks
- POST /webhooks/batch.jsonpost

Incentives

Points
Allocations
Benefits
Rewards
- POST /rewards/batch.jsonpost
- GET /rewards/{reward}/trigger-target/{type}get
Estimate Incentivespost
Achievements
Benefits
Points
- Browse Profile Pointsget
- Read Profile Pointget
Rewards
Redemptions
Redemption Returns
- Add Benefit Returnpost
Reward or Point Returns
- Add Reward or Point Returnpost
Redemption Reversals
- Add Redemption Reversalpost
Credits
List Definitions
List Reservations
Shares

Extension Brauz

webhook
- Process a Brauz Webhookpost

Powered by

GET /benefits/definitions/handle/{handle}

get

https://{tenant}.getomneo.com/api/v3/benefits/definitions/handle/{handle}

Display a benefit definition by handle.

Language

Credentials

Header

URL