Jump to Content
Guides
Help Centre
Home
Guides
Recipes
API Reference
Changelog
v3.9.0
Guides
Help Centre
Contact
API Reference
Contact
v3.9.0
Home
Guides
Recipes
API Reference
Changelog
GET /systems
All
Pages
Start typing to search…
JUMP TO
Authentication
Auth
GET /auth/access-tokens
get
POST /auth/discovery
post
GET /auth/verify
get
Access Tokens
Browse Access tokens
get
Delete an Access Token
del
Add Access Token
post
API Tokens
Browse API Tokens
get
Add API Token
post
Delete an API Token
del
Delegation Tokens
Add Delegation Token
post
Scopes
Browse Scopes
get
Profiles
Profile Credits
GET /profiles/{profile}/credits
get
Profile Redemptions
GET /profiles/{profile}/linked_redemptions
get
GET /profiles/{profile}/linked/redemptions
get
GET /profiles/{profile}/redemptions/{type}/{id}/count
get
Profile Rewards
POST /profiles/{profileId}/rewards
post
PUT /profiles/{profileId}/rewards/{rewardId}
put
DELETE /profiles/{profileId}/rewards/{rewardId}
del
Profile Benefits
POST /profiles/{profile}/benefits/claim
post
GET /profiles/{profile}/benefits/viewable
get
Profile Achievements
GET /profiles/{profile}/achievements/{definition}/achievement-points
get
Profile Transactions
GET /profiles/{profile}/find-transactions
get
GET /profiles/{profile}/group_transactions
get
GET /profiles/{profile}/transactions/claims
get
POST /profiles/{profile}/transactions/claims
post
GET /profiles/{profile}/transactions/claims/{transactionClaim}
get
DELETE /profiles/{profile}/transactions/claims/{transactionClaim}
del
POST /profiles/{profile}/transactions/items/{transactionitem}/list-item
post
GET /profiles/{profile}/transactions/{transaction}/unattach
get
Profile Aggregations
PUT /profiles/{profileId}/aggregations
put
GET /profiles/{profile}/aggregations/calculate
get
Profile Tiers
POST /profiles/{profile}/tiers/assign
post
GET /profiles/{profile}/tiers/calculate
get
GET /profiles/{profile}/tiers/points
get
Profile Connections
PUT /profiles/{profileId}/connections/{connectionId}
put
Profile Addresses
POST /profiles/{profile}/addresses/upsert
post
Profile Attributes
POST /profiles/{profileId}/attributes/custom
post
GET /profiles/{profile}/attributes/custom/{custom}
get
PUT /profiles/{profile}/attributes/custom/{custom}
put
DELETE /profiles/{profile}/attributes/custom/{custom}
del
Profile Identities
GET /profiles/{profile}/identities/id/{identity}
get
PUT /profiles/{profile}/identities/id/{identity}
put
DELETE /profiles/{profile}/identities/id/{identity}
del
Product Lists
GET /product-lists/search
get
Profile Transaction Items
GET /profiles/{profile}/transactionitems/list/{type}
get
Profile Transaction Products
GET /profiles/{profile}/transaction-products
get
Profile Resync
GET /profiles/{profile}/resync
get
Profile Lists
POST /profiles/{profile}/lists/{handle}/custom
post
GET /profiles/{profile}/lists/{list}/custom-fields
get
POST /profiles/{profile}/lists/{list}/custom-fields
post
GET /profiles/{profile}/lists/{list}/custom-fields/{custom_field}
get
PUT /profiles/{profile}/lists/{list}/custom-fields/{custom_field}
put
DELETE /profiles/{profile}/lists/{list}/custom-fields/{custom_field}
del
GET /profiles/{profile}/lists/{list}/shares
get
POST /profiles/{profile}/lists/{list}/shares
post
GET /profiles/{profile}/lists/{list}/shares/{share}
get
PUT /profiles/{profile}/lists/{list}/shares/{share}
put
DELETE /profiles/{profile}/lists/{list}/shares/{share}
del
Identities
GET /identities/search-profile/{identifier}
get
Profile Orders
DELETE /profiles/{profile}/orders/{order}
del
GET /profiles/{profile}/group_orders
get
GET /profiles/{profile}/orders
get
GET /profiles/{profile}/orders/{order}
get
POST /profiles/{profile}/orders
post
PUT /profiles/{profile}/orders/{order}
put
Profile Ledgers
GET /profiles/{profile}/ledgers
get
GET /profiles/{profile}/ledgers/{ledger}
get
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
del
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
del
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
del
Profile Attributes (Custom)
GET /profiles/attributes/custom
get
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
del
Read Profile List Items
get
Add Profile List Item
post
Read Profile List Item
get
Edit Profile List Item
put
Delete Profile List Item
del
Profiles
POST /profiles/exists
post
POST /profiles/batch.json
post
POST /profiles/{profile}/custom-event
post
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
del
Purge Profile
del
Update Profile Type
put
Profile Region
DELETE /profiles/{profile}/regions/{region}
del
GET /profiles/{profile}/regions
get
GET /profiles/{profile}/regions/{region}
get
POST /profiles/{profile}/regions
post
PUT /profiles/{profile}/regions/{region}
put
Profile Points
GET /profiles/{profile}/linked_points
get
Profie Interactions
DELETE /profiles/{profile}/interactions/{interaction}
del
GET /profiles/{profile}/interactions
get
GET /profiles/{profile}/interactions/{interaction}
get
Profile Batches
POST /profile/status/batch.json
post
DELETE /profile/tags/batch.json
del
POST /profile/tags/batch.json
post
DELETE /profile/status/batch.json
del
POST /profile/aggregations/batch.json
post
Business
Custom Fields
GET /custom-fields/search
get
GET /custom-fields/{model}/{id}
get
POST /custom-fields/{model}/{id}
post
DELETE /custom-fields/{model}/{id}/batchJsonDelete
del
DELETE /custom-fields/{model}/{id}/{customField}
del
Transactions
POST /transactions/batch.json
post
PUT /transactions/items/{transactionitem}
put
POST /transactions/items/{transactionitem}/list-item
post
POST /transactions/items/{transactionitem}/resend
post
POST /transactions/queue/create
post
POST /transactions/{id}/resend
post
GET /transactions/{transaction}/custom-fields
get
POST /transactions/{transaction}/custom-fields
post
GET /transactions/{transaction}/custom-fields/{custom_field}
get
PUT /transactions/{transaction}/custom-fields/{custom_field}
put
DELETE /transactions/{transaction}/custom-fields/{custom_field}
del
Products
POST /products/batch.json
post
POST /products/create-update
post
GET /products/variants
get
Staff
GET /staff/{staffIdentifier}
get
Connections
PUT /connections/{connectionId}
put
List
GET /list/items/{itemId}/reservations
get
GET /list/items/{itemId}/reservations/{reservationId}
get
Custom Products
GET /customProducts
get
POST /customProducts
post
GET /customProducts/{customProduct}
get
PUT /customProducts/{customProduct}
put
DELETE /customProducts/{customProduct}
del
Lists
GET /lists/shares/{handle}
get
GET /lists/shares/{handle}/no_profile
get
GET /lists/{list}
get
Interactions
GET /interactions
get
POST /interactions
post
GET /interactions/{interaction}
get
PUT /interactions/{interaction}
put
DELETE /interactions/{interaction}
del
Orders
GET /orders
get
POST /orders
post
POST /orders/batch.json
post
POST /orders/queue
post
POST /orders/queue/create
post
POST /orders/{id}/resend
post
GET /orders/{order}
get
PUT /orders/{order}
put
DELETE /orders/{order}
del
Redemptions
GET /redemptions/group/{attribute}
get
Tiers
GET /tiers/points
get
POST /tiers/points
post
GET /tiers/points/{point}
get
PUT /tiers/points/{point}
put
DELETE /tiers/points/{point}
del
Import Jobs
Browse Import Jobs
get
Add Import Job
post
Read Import Job
get
Export Import Jobs
post
Batch Import Jobs
post
Transaction Items
Browse Transaction Items
get
Add Transaction Item
post
Read Transaction Item
get
Edit Transaction Item
put
Delete a transaction item
del
Products
Browse Products
get
Add Product
post
Queue Product
post
Update or Create Product
post
Read Product
get
Edit Product
put
Delete Product
del
Product Variants
Browse Product Variants
get
Add Product Variant
post
Read Product Variant
get
Edit Product Variant
put
Delete Product Variant
del
Locations
Browse Locations
get
Add Location
post
Read Location
get
Edit Location
put
Delete Location
del
Read Location By External
get
Order Items
Browse Order Items
get
Add Order Item
post
Read Order Item
get
Edit Order Item
put
Delete an order item
del
Organisation Profiles
List all profiles in an organisation
get
Add a profile to an organisation
post
Remove a profile from an organisation
del
Staff Profiles
Add Staff Profile
post
Edit Staff Profile
put
Delete Staff Profile
del
Ratings
Browse Ratings
get
Add Rating
post
Read Rating
get
Edit Rating
put
Delete Rating
del
Imports
Browse Imports
get
Upload Import
post
Create Manual Import
post
Upload Import Mapping File
post
Browse Conditional Imports
post
Read Import
get
Delete Import
del
Transactions
Browse Transactions
get
Add Transaction
post
Queue Transaction
post
Create or Update a Transaction
post
Read Transaction
get
Edit Transaction
put
Delete Transaction
del
Read Transaction by External ID
get
Browse Profile Transactions
get
Read Profile Transaction
get
Trigger Transaction Event
post
Organisations
List all organisations
get
Create a new organisation
post
Get organisation by ID
get
Update organisation
put
Delete organisation
del
Configuration
Locations
POST /locations/batch.json
post
GET /locations/{location}/custom-fields
get
POST /locations/{location}/custom-fields
post
GET /locations/{location}/custom-fields/{custom_field}
get
PUT /locations/{location}/custom-fields/{custom_field}
put
DELETE /locations/{location}/custom-fields/{custom_field}
del
Roles
GET /roles
get
GET /roles/{role}
get
Brands
GET /brands
get
POST /brands
post
GET /brands/{brand}
get
PUT /brands/{brand}
put
DELETE /brands/{brand}
del
Countries
GET /countries
get
POST /countries
post
GET /countries/{country}
get
PUT /countries/{country}
put
DELETE /countries/{country}
del
Currencies
GET /currencies
get
POST /currencies
post
GET /currencies/{currency}
get
PUT /currencies/{currency}
put
DELETE /currencies/{currency}
del
Departments
GET /departments
get
POST /departments
post
GET /departments/{department}
get
PUT /departments/{department}
put
DELETE /departments/{department}
del
Rates
GET /rates
get
POST /rates
post
POST /rates/calculate
post
GET /rates/searchAttributes/{attribute}
get
GET /rates/{rate}
get
PUT /rates/{rate}
put
DELETE /rates/{rate}
del
Regions
GET /regions
get
POST /regions
post
GET /regions/{region}
get
PUT /regions/{region}
put
DELETE /regions/{region}
del
Systems
GET /systems
get
POST /systems
post
GET /systems/{system}
get
DELETE /systems/{system}
del
Tags
GET /tags
get
POST /tags
post
GET /tags/{tag}
get
DELETE /tags/{tag}
del
Saved Filters
Browse Saved Filters
get
Add Saved Filter
post
Edit Saved Filter
put
Delete Saved Filter
del
Achievement Definitions
Browse Achievement Definitions
get
Add Achievement Definition
post
Edit Achievement Definition
put
Delete Achievement Definition
del
Benefit Definitions
Browse Benefit Definitions
get
Add Benefit Definition
post
Read Benefit Definition
get
Edit Benefit Definition
put
Delete Benefit Definition
del
Clone a Benefit Definition
post
Credit Definitions
Browse Credit Definitions
get
Add Credit Definition
post
Read Credit Definition
get
Edit Credit Definition
put
Delete Credit Definition
del
Point Definitions
Browse Point Definitions
get
Add Point Definition
post
Read Point Definition
get
Edit Point Definition
put
Delete Point Definition
del
Reward Definitions
Browse Reward Definitions
get
Add Reward Definition
post
Read Reward Definition
get
Update a reward definition
put
Delete Reward Definition
del
Tier Definitions
Browse Tier Definitions
get
Add Tier Definition
post
Read Tier Definition
get
Edit Tier Definition
put
Delete Tier Definition
del
Connection Definitions
Browse Connection Definitions
get
Add Connection Definition
post
Read Connection Definition
get
Edit Connection Definition
put
Delete Connection Definition
del
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
del
Statuses
Browse Statuses
get
Add Status
post
Read Status
get
Edit Status
put
Delete Status
del
Targets
Browse Targets
get
Add a Target
post
Read a Target
get
Edit a Target
put
Delete the Target
del
Webhooks
Browse webhooks
get
Add a Webhook
post
Read a Webhook
get
Edit a Webhook
put
Delete the Webhook
del
Triggers
Browse triggers
get
Add a trigger
post
Read a trigger
get
Edit a trigger
post
Delete the trigger
del
Read trigger actions
get
Add a trigger action
post
Read a specific trigger action
get
Update an Trigger action
put
Delete the trigger action
del
Automations
Browse automations
get
Add an automation
post
Read an automation
get
Edit an automation
put
Delete the automation
del
Read automation actions
get
Add an automation action
post
Read a specific automation action
get
Update an automation action
put
Delete the automation action
del
Settings
Browse settings
get
Read a Setting
get
Edit a setting
put
Delete the setting
del
Users
Browse users
get
Add a user
post
Read a user
get
Edit a user
put
Delete the user
del
Read the authenticated user
get
Edit the authenticated user
put
Delete the user
del
Roles
Browse Roles
get
Read a Role
get
Permissions
Browse Permissions
get
Read a Permission
get
Audits
Browse Audits
get
Read an Audit
get
Connections
Browse Connections
get
Add Connection
post
Read A Connection
get
Delete Connection
del
Settings
Tenants
POST /tenants/custom-event
post
GET /tenants/custom-fields
get
POST /tenants/custom-fields
post
GET /tenants/custom-fields/{custom_field}
get
PUT /tenants/custom-fields/{custom_field}
put
DELETE /tenants/custom-fields/{custom_field}
del
Reminders
GET /reminders
get
POST /reminders
post
GET /reminders/{reminder}
get
PUT /reminders/{reminder}
put
DELETE /reminders/{reminder}
del
Action History
GET /action-history
get
GET /action-history/{action_history}
get
Audits
POST /audits
post
PUT /audits/{auditId}
put
DELETE /audits/{auditId}
del
Permissions
POST /permissions
post
PUT /permissions/{PermissionId}
put
DELETE /permissions/{PermissionId}
del
Settings
POST /settings
post
GET /settings/environment
get
Automations
POST /automations/queries/samples
post
POST /automations/{automation}/trigger
post
Triggers
PUT /triggers/{triggerId}
put
Webhooks
POST /webhooks/batch.json
post
Incentives
Points
GET /points
get
POST /points
post
GET /points/{point}
get
Allocations
GET /allocations
get
POST /allocations/batch.json
post
GET /allocations/{benefitdefinition}/count
get
Benefits
PUT /benefits/{benefitId}
put
POST /benefits/batch.json
post
GET /benefits/definitions/handle/{handle}
get
POST /benefits/extend
post
GET /benefits/{benefit}/trigger-target/{type}
get
Rewards
POST /rewards/batch.json
post
GET /rewards/{reward}/trigger-target/{type}
get
Estimate Incentives
post
Achievements
Browse Profile Achievements
get
Read An Achievement Definition
get
Add Profile Achievement
post
Benefits
Browse Benefits
get
Browse Profile Redeemable Benefits
get
Add Benefit
post
Read Benefits Count
get
Read Benefit
get
Delete Benefit
del
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
del
Points
Browse Profile Points
get
Read Profile Point
get
Rewards
Browse Rewards
get
Add Reward
post
Read Reward
get
Edit Reward
put
Delete Reward
del
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, Point, or Credit Redemption
post
Redemption Returns
Add Benefit Return
post
Reward or Point Returns
Add Reward or Point Return
post
Redemption Reversals
Add Redemption Reversal
post
Credits
Browse Credits
get
Add Credit
post
Read Credit
get
Edit Credit
put
Delete Credit
del
Redeem Profile Credit
post
Extend Credit
post
List Definitions
Browse List Definitions
get
Add List Definition
post
Read List Definition
get
Edit List Definition
put
Delete List Definition
del
List Reservations
Add List Reservation
post
Edit List Reservation
put
Delete List Reservation
del
Browse Profile Reservations
get
Shares
Browse Shares
get
Add Share
post
Read Share
get
Edit Share
put
Delete Share
del
Claim Share
post
Extension Brauz
webhook
Process a Brauz Webhook
post
Powered by
GET /systems
Ask AI
get
https://{tenant}.getomneo.com/api/v3/systems
List systems.
Language
JSON
Credentials
Header
Header
URL
Base URL
https://
tenant
.getomneo.com/api/v3
/systems
