Most Omneo resources are accessible through two distinct route patterns. Choosing the right one matters for both correctness and performance.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 two patterns
Global endpoints operate on all records of a resource across the entire tenant. They are designed for integration work: importing data, running bulk operations, querying across all profiles, or triggering admin-level updates. Example:GET /v3/transactions returns all transactions in the tenant.
Profile-scoped endpoints operate on records belonging to a specific profile. They are designed for customer-facing work: building loyalty UIs, profile screens, membership apps, or any context where you already hold a profile identifier.
Example: GET /v3/profiles/{id}/transactions returns transactions for one profile.
Both patterns expose the same underlying data. The difference is scope, access pattern, and the assumptions built into the response shape.
When to use each
| Use case | Route to use |
|---|---|
| Bulk import or export | Global |
| Admin dashboard queries | Global |
| Reporting across all profiles | Global |
| Loyalty app or member portal | Profile-scoped |
| POS or checkout integration showing a customer’s balance | Profile-scoped |
| Reading or updating a single customer’s records | Profile-scoped |
| Triggers and automation actions | Global |
Endpoint pairs
The following groups each have both a global and a profile-scoped variant.| Resource | Global endpoint | Profile-scoped endpoint |
|---|---|---|
| Transactions | Transactions | Profile Transactions |
| Interactions | Interactions | Profile Interactions |
| Rewards | Rewards | Profile Rewards |
| Benefits | Benefits | Profile Benefits |
| Points | Points | Profile Points |
| Redemptions | Redemptions | Profile Redemptions |
| Statuses | Statuses | Profile Statuses |