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.

The Omneo API lets you manage loyalty profiles, transactions, incentives, automations, and the full configuration layer that powers them. All endpoints are RESTful and return JSON. Base URL 
https://api.{tenant}.getomneo.com/api/v3
Replace {tenant} with your Omneo tenant identifier. Find your tenant name in your CX Manager URL: https://{tenant}.manager.getomneo.com.

API schema

Download the OpenAPI schema

​
Authentication

All endpoints require a Bearer token in the Authorization header: 
Authorization: Bearer <your-token>
See Authentication for all four auth methods (OAuth, Personal Access Token, Shopify, Proxy) and when to use each.

​
API structure

The API is organised into sections that follow Omneo’s conceptual model. Each section corresponds to a domain in the Concepts layer.

Profiles

Core profile CRUD plus all profile-scoped attributes: identity, address, aggregation, comms, appearance, custom, dates, connections, and validation rules.

Commerce

Transactions, orders, products, and locations. Transactions are immutable once created — use orders for mutable pre-purchase records.

Incentives

Rewards, points, benefits, credits, tiers, and achievements. All follow a Definition → Instance pattern: configure a Definition, then issue Instances to profiles.

Lists

Profile-linked product catalogues — wishlists, gift registries, style guides. Includes list definitions, items, reservations, and sharing.

Automation

Triggers (event-driven) and Automations (schedule-driven), with their Actions, Targets, and Webhooks. See Reactions for the conceptual overview.

Organisations and access

Organisations, users, staff, roles, permissions, and organisation-profile relationships.

Configuration

Connections, statuses, tags, custom fields, rates, brands, regions, and reference data.

Platform

Imports, batch operations, ledger, audit trail, settings, and platform health.

​
Key conventions

Profile-scoped vs global endpoints Many resources have two endpoint families: a global set (e.g., GET /v3/rewards) and a profile-scoped set (e.g., GET /v3/profiles/{id}/rewards). Profile-scoped endpoints return only the records belonging to that profile and are the right choice for customer-facing operations. The Definition → Instance pattern Incentive types (rewards, benefits, points, credits, tiers, achievements) all use this pattern. A Definition is the configuration template; an Instance is the record created when that incentive is issued to a profile. Definitions live in the Configuration section; Instances live in the Incentives section. Transactions are immutable Once a transaction is created, it cannot be edited. If you need mutable purchase records, use Orders. A single order can produce zero, one, or many transactions. Batch endpoints Most resource types have a batch endpoint for bulk operations. Batch endpoints accept arrays of records and process them asynchronously. Use the Import API for large-scale data loads.