> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rigaly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Most used routes

> The endpoints most integrations need, with example cases

Most integrations use a handful of endpoints. Start here, then browse the [complete reference](/api-reference).

## The essentials

| Route                                      | What it does                                                         | Typical caller                           |
| ------------------------------------------ | -------------------------------------------------------------------- | ---------------------------------------- |
| `POST /api/v1/points/issue`                | Award points for a purchase                                          | Your checkout / order webhook            |
| `GET /api/v1/customers/lookup`             | Resolve email / phone / your customer ID → Rigaly customer + balance | Your POS or account page                 |
| `GET /api/v1/redemptions/{code}`           | Validate a reward code the customer shows, without consuming it      | Your checkout                            |
| `POST /api/v1/redemptions/{code}/complete` | Consume the code and deduct the points                               | Your checkout, after applying the reward |
| `POST /api/v1/code-batches` + `/export`    | Generate up to 100k printable codes for physical products            | Your ops team, per production run        |
| `GET/POST/PATCH/DELETE /api/v1/rewards`    | Manage the rewards customers see in the app                          | Your admin tooling                       |

## Example cases

<CardGroup cols={1}>
  <Card title="Basic: issue points and validate rewards" icon="gift" href="/guides/issue-and-validate">
    The core loop — award points on every order, honor rewards at checkout. Start with this one.
  </Card>

  <Card title="Earn points on specific products or hours only" icon="clock" href="/guides/product-specific-earning">
    Your code decides which line items qualify (e.g. only coffee SKUs, only 2–5 pm) and sends Rigaly the qualifying amount.
  </Card>

  <Card title="Claim rewards on specific products only" icon="tags" href="/guides/product-specific-redemption">
    Validate the code, check the cart against the reward's conditions, then complete.
  </Card>

  <Card title="Mass codes for physical products" icon="qrcode" href="/guides/mass-codes">
    Print unique single-use codes on bottles, boxes, or receipts — you're only charged when a code is redeemed.
  </Card>
</CardGroup>

## Complete route list

**Meta** — `GET /me`

**Points** — `POST /points/issue` · `POST /points/redeem`

**Customers** — `GET /customers/lookup` · `GET /customers/{userId}/balance` · `GET|POST /customers/{userId}/identifiers` · `PATCH|DELETE /customers/{userId}/identifiers/{id}`

**Rewards** — `GET|POST /rewards` · `GET|PATCH|DELETE /rewards/{id}`

**Redemptions** — `GET /redemptions/{code}` · `POST /redemptions/{code}/complete`

**Code batches** — `GET|POST /code-batches` · `GET /code-batches/{id}` · `GET /code-batches/{id}/export` · `POST /code-batches/{id}/deactivate` · `POST /code-batches/verify`

**Promotions** — `GET|POST /promotions` · `GET|PATCH|DELETE /promotions/{id}`

**Raffles** — `GET|POST /raffles` · `GET|PATCH|DELETE /raffles/{id}` · `POST /raffles/{id}/cancel` · `POST /raffles/{id}/end` · `GET /raffles/{id}/entries` · `GET /raffles/{id}/winners`

**Levels (tiers)** — `GET|POST /tiers` · `PATCH|DELETE /tiers/{id}` · `PATCH /tiers/settings` · `POST /tiers/reorder` · `GET|PUT /customers/{userId}/tier`

**Segments** — `GET /segments/presets` · `POST /segments/preview` · `POST /segments/customers`

**Transactions** — `GET /transactions` (business-wide, filterable)

**Devices** — `GET /devices` (read-only)

**Reviews** — `GET /reviews` · `GET /reviews/summary` · `GET|PUT|DELETE /reviews/questionnaire`