> ## 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.

# Omneo API Reference

> REST API for the Omneo loyalty and CX platform

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**

```text theme={null}
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`.

<Warning>
  All requests must be made over a secure `https` connection and must not include port numbers.
</Warning>

<CardGroup cols={2}>
  <Card title="API schema" icon="file-code" href="/api-reference/api.json">
    Download the OpenAPI schema.
  </Card>

  <Card title="API changelog" icon="clock-rotate-left" href="/api-reference/changelog">
    Release history and upcoming changes for the Omneo API.
  </Card>
</CardGroup>

## Authentication

All endpoints require a Bearer token in the `Authorization` header:

```http theme={null}
Authorization: Bearer <your-token>
```

See [Authentication](/dev-guides/core-setup/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](/concepts/glossary) layer.

<CardGroup cols={2}>
  <Card title="Profiles" icon="user" href="/api-reference/profile/overview">
    Core profile CRUD plus all profile-scoped attributes: identity, address, aggregation, comms, appearance, custom, dates, connections, and validation rules.
  </Card>

  <Card title="Commerce" icon="shopping-cart" href="/api-reference/transaction/overview">
    Transactions, orders, products, and locations. Transactions are immutable once created — use orders for mutable pre-purchase records.
  </Card>

  <Card title="Incentives" icon="gift" href="/api-reference/reward/overview">
    Rewards, points, benefits, credits, tiers, and achievements. All follow a [Definition → Instance](/concepts/incentives/overview) pattern: configure a Definition, then issue Instances to profiles.
  </Card>

  <Card title="Lists" icon="list" href="/api-reference/product-list/overview">
    Profile-linked product catalogues — wishlists, gift registries, style guides. Includes list definitions, items, reservations, and sharing.
  </Card>

  <Card title="Automation" icon="bolt" href="/api-reference/trigger/overview">
    Triggers (event-driven) and Automations (schedule-driven), with their Actions, Targets, and Webhooks. See [Reactions](/concepts/automation/reactions) for the conceptual overview.
  </Card>

  <Card title="Organisations and access" icon="building" href="/api-reference/organisation/list-all-organisations">
    Organisations, users, staff, roles, permissions, and organisation-profile relationships.
  </Card>

  <Card title="Configuration" icon="gear" href="/api-reference/connection/browse-connections">
    Connections, statuses, tags, custom fields, rates, brands, regions, and reference data.
  </Card>

  <Card title="Platform" icon="server" href="/api-reference/import/browse-imports">
    Imports, batch operations, ledger, audit trail, settings, and platform health.
  </Card>
</CardGroup>

## 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.