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

# List rewards

> Retrieve the account's points reward catalog.

## GET `/rewards`

Retrieve the account's points reward catalog.

Send `Authorization: Bearer YOUR_API_KEY` and `X-Device-ID: YOUR_DEVICE_ID`. See [authentication](https://tapcoupon.mintlify.site/authentication.md).

The response is an array of reward definitions. To display rewards configured for a points card, match these ids against `card.program.rewardIds`, or use [public card rewards](https://tapcoupon.mintlify.site/api-reference/cards/public-rewards.md).

`pointsNeeded` is the cost to redeem. `cooldownHours` is an integer from `0` to `8760`; `0` disables cooldowns. This catalog does not include per-card cooldown timestamps.

### Example request

```bash theme={null}
curl "https://tapcoupon.at/api/v1/rewards" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Device-ID: YOUR_DEVICE_ID"
```

### Example response

```json theme={null}
[
  {
    "id": "693869428d49e641ba110e18",
    "name": "Free coffee",
    "description": "One coffee",
    "pointsNeeded": 100,
    "cooldownHours": 24
  }
]
```


## OpenAPI

````yaml api-reference/openapi.json GET /rewards
openapi: 3.1.0
info:
  title: TapCoupon POS and partner API
  version: 1.0.0
  description: >-
    API-key POS operations, customer card views, and partner payment sessions.
    Verified against the tap_coupon backend on 2026-10-02. Dashboard /clients
    and administrative routes use separate authentication and are outside this
    reference.
servers:
  - url: https://tapcoupon.at/api/v1
security: []
paths:
  /rewards:
    get:
      tags:
        - Other
      summary: List rewards
      description: Retrieve the account's points reward catalog.
      operationId: other_rewards
      parameters:
        - name: X-Device-ID
          in: header
          required: true
          description: Stable device identifier. API key binds to this value on first use.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Reward'
              example:
                - id: 693869428d49e641ba110e18
                  name: Free coffee
                  description: One coffee
                  pointsNeeded: 100
                  cooldownHours: 24
        '401':
          description: >-
            Missing or invalid API key, device id, employee token, or
            credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Device binding mismatch, archived location, employee location
            restriction, or account restriction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit exceeded. The response body is determined by the
            rate-limit middleware.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Reward:
      type: object
      properties:
        id:
          type: string
          description: MongoDB object id.
          pattern: ^[a-fA-F0-9]{24}$
        pocketId:
          type: string
        name:
          type: string
        description:
          type: string
        pointsNeeded:
          type: integer
          minimum: 1
        cooldownHours:
          type: integer
          description: Cooldown per card and reward; 0 disables it.
          minimum: 0
          maximum: 8760
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error.
        errorCode:
          type: string
          description: >-
            Handler errors include a machine-readable code; middleware errors
            may omit it.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Location API key. Also requires X-Device-ID.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.