Jump to Content
Guides
Help Centre
Home
Guides
Recipes
API Reference
Changelog
v3.6.9
Guides
Help Centre
Contact
API Reference
Contact
v3.6.9
Home
Guides
Recipes
API Reference
Changelog
List all role definitions
All
Pages
Start typing to search…
JUMP TO
Authentication
Access Tokens
Browse Access tokens
get
Delete an Access Token
delete
Add Access Token
post
API Tokens
Browse API Tokens
get
Add API Token
post
Delete an API Token
delete
Delegation Tokens
Add Delegation Token
post
Scopes
Browse Scopes
get
Profiles
Profiles
Browse Profiles
get
Add Profile
post
Sync Profiles
post
Get Profile By Id or Identity
post
Merge Profiles
post
Batch Profiles
post
Check Availability
post
Read Profile
get
Edit Profile
put
Delete Profile
delete
Purge Profile
delete
Update Profile Type
put
Profile Additional Data
Read Aggregations
get
Read Profile Balances
get
Read Profile Tier
get
Profile Connections
Read Profile Connections
get
Read Single Profile Connection
get
Read Connected Profile Data
get
Profile Addresses
Browse Profile Addresses
get
Add Profile Address
post
Read Profile Address
get
Edit Profile Address
put
Delete Profile Address
delete
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)
Read Profile Attributes (Dates)
get
Edit Profile Attributes (Dates)
put
Delete Profile Date Attribute
delete
Profile Identities
Browse Profile Identities
get
Read Profile's Identities
get
Add Profile Identity
post
Read Profile Identity
get
Edit Profile Identity
put
Delete Profile Identity
delete
Profile Attributes (Custom)
Read Profile Attributes (Custom)
get
Edit Profile Attributes (Custom)
put
Profile Lists
Browse Profile Lists
get
Add Profile List
post
Read Profile List
get
Edit Profile List
put
Delete Profile List
delete
Read Profile List Items
get
Add Profile List Item
post
Read Profile List Item
get
Edit Profile List Item
put
Delete Profile List Item
delete
Business
Transactions
Browse Transactions
get
Add Transaction
post
Queue Transaction
post
Create or Update a Transaction
post
Read Transaction
get
Edit Transaction
put
Delete Transaction
delete
Read Transaction by External ID
get
Browse Profile Transactions
get
Read Profile Transaction
get
Transaction Items
Browse Transaction Items
get
Add Transaction Item
post
Read Transaction Item
get
Edit Transaction Item
put
Delete a transaction item
delete
Products
Browse Products
get
Add Product
post
Queue Product
post
Update or Create Product
post
Read Product
get
Edit Product
put
Delete Product
delete
Product Variants
Browse Product Variants
get
Add Product Variant
post
Read Product Variant
get
Edit Product Variant
put
Delete Product Variant
delete
Locations
Browse Locations
get
Add Location
post
Read Location
get
Edit Location
put
Delete Location
delete
Read Location By External
get
Staff Profiles
Add Staff Profile
post
Edit Staff Profile
put
Delete Staff Profile
delete
Ratings
Browse Ratings
get
Add Rating
post
Read Rating
get
Edit Rating
put
Delete Rating
delete
Configuration
Achievement Definitions
Browse Achievement Definitions
get
Add Achievement Definition
post
Edit Achievement Definition
put
Delete Achievement Definition
delete
Automations
Browse automations
get
Add an automation
post
Read an automation
get
Edit an automation
put
Delete the automation
delete
Read automation actions
get
Add an automation action
post
Read a specific automation action
get
Update an automation action
put
Delete the automation action
delete
Audits
Browse Audits
get
Read an Audit
get
Benefit Definitions
Browse Benefit Definitions
get
Add Benefit Definition
post
Read Benefit Definition
get
Edit Benefit Definition
put
Delete Benefit Definition
delete
Clone a Benefit Definition
post
Connections
Browse Connections
get
Add Connection
post
Read A Connection
get
Delete Connection
delete
Connection Definitions
Browse Connection Definitions
get
Add Connection Definition
post
Read Connection Definition
get
Edit Connection Definition
put
Delete Connection Definition
delete
Organisation Profiles
List all profiles in an organisation
get
Add a profile to an organisation
post
Remove a profile from an organisation
delete
Organisations
List all organisations
get
Create a new organisation
post
Get organisation by ID
get
Update organisation
put
Delete organisation
delete
Permissions
Browse Permissions
get
Read a Permission
get
Point Definitions
Browse Point Definitions
get
Add Point Definition
post
Read Point Definition
get
Edit Point Definition
put
Delete Point Definition
delete
Reward Definitions
Browse Reward Definitions
get
Add Reward Definition
post
Read Reward Definition
get
Update a reward definition
put
Delete Reward Definition
delete
Roles
Browse Roles
get
Read a Role
get
Role Definitions
List all role definitions
get
Create a new role definition
post
Get role definition by ID
get
Update role definition
put
Delete role definition
delete
Settings
Browse settings
get
Read a Setting
get
Edit a setting
put
Delete the setting
delete
Statuses
Browse Statuses
get
Add Status
post
Read Status
get
Edit Status
put
Delete Status
delete
Targets
Browse Targets
get
Add a Target
post
Read a Target
get
Edit a Target
put
Delete the Target
delete
Tier Definitions
Browse Tier Definitions
get
Add Tier Definition
post
Read Tier Definition
get
Edit Tier Definition
put
Delete Tier Definition
delete
Triggers
Browse triggers
get
Add a trigger
post
Read a trigger
get
Edit a trigger
post
Delete the trigger
delete
Read trigger actions
get
Add a trigger action
post
Read a specific trigger action
get
Update an Trigger action
put
Delete the trigger action
delete
Users
Browse users
get
Add a user
post
Read a user
get
Edit a user
put
Delete the user
delete
Read the authenticated user
get
Edit the authenticated user
put
Delete the user
delete
Webhooks
Browse webhooks
get
Add a Webhook
post
Read a Webhook
get
Edit a Webhook
put
Delete the Webhook
delete
Incentives
Achievements
Browse Profile Achievements
get
Add Profile Achievement
post
Benefits
Browse Benefits
get
Add Benefit
post
Read Benefits Count
get
Read Benefit
get
Delete Benefit
delete
Browse Profile Benefits
get
Browse Profile Claimable Benefits
get
Add Benefit Claim
post
Add and Redeem Benefit Claim
post
Read Profile Benefit
get
Update a profile Benefit
put
Delete Benefit
delete
Points
Browse Profile Points
get
Read Profile Point
get
Rewards
Browse Rewards
get
Add Reward
post
Read Reward
get
Edit Reward
put
Delete Reward
delete
Extend Reward
post
Browse Profile Rewards
get
Read Profile Reward
get
Redemptions
Browse Profile Redemptions
get
Read Profile Redemption
get
Add Benefit Redemption
post
Add Reward or Point Redemption
post
Redemption Returns
Add Benefit Return
post
Reward or Point Returns
Add Reward or Point Return
post
Redemption Reversals
Add Redemption Reversal
post
Extension Brauz
webhook
Process a Brauz Webhook
post
Ask AI
List all role definitions
get
https://{tenant}.getomneo.com/api/v3/roles/definitions
Language
JSON
Credentials
Header
Header
URL
Base URL
https://
tenant
.getomneo.com/api/v3
/roles/definitions
