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

# Customers

> Retrieve customers for your API key's account.

## GET `/customers`

Retrieve customers for your API key's account.

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 customer records with nested `contact`, optional `address`, timestamps, consent, and statistics. See [customer data](https://tapcoupon.mintlify.site/customer-data.md).

### Example request

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

### Example response

```json theme={null}
[
  {
    "email": "bob@example.com",
    "contact": {
      "fullName": "Bob Example",
      "phone": "+43123456789"
    },
    "address": {
      "line1": "Bakers Street 41",
      "city": "Vienna",
      "postalCode": "1010",
      "countryCode": "AT"
    },
    "birthdate": "1990-06-15T00:00:00Z",
    "privacyConsentGiven": true,
    "createdAt": "2026-10-02T12:00:00Z",
    "updatedAt": "2026-10-02T12:00:00Z",
    "stats": {
      "totalLoyaltyBonusEarned": 0,
      "totalLoyaltyBonusUsed": 0,
      "totalCouponsPurchased": 1,
      "totalCouponsRedeemed": 0
    }
  }
]
```


## OpenAPI

````yaml api-reference/openapi.json GET /customers
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:
  /customers:
    get:
      tags:
        - Other
      summary: Customers
      description: Retrieve customers for your API key's account.
      operationId: other_customers
      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/Customer'
              example:
                - email: bob@example.com
                  contact:
                    fullName: Bob Example
                    phone: '+43123456789'
                  address:
                    line1: Bakers Street 41
                    city: Vienna
                    postalCode: '1010'
                    countryCode: AT
                  birthdate: '1990-06-15T00:00:00Z'
                  privacyConsentGiven: true
                  createdAt: '2026-10-02T12:00:00Z'
                  updatedAt: '2026-10-02T12:00:00Z'
                  stats:
                    totalLoyaltyBonusEarned: 0
                    totalLoyaltyBonusUsed: 0
                    totalCouponsPurchased: 1
                    totalCouponsRedeemed: 0
        '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:
    Customer:
      allOf:
        - $ref: '#/components/schemas/CustomerInput'
        - type: object
          properties:
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
            stats:
              type: object
              properties:
                totalLoyaltyBonusEarned:
                  type: integer
                totalLoyaltyBonusUsed:
                  type: integer
                totalCouponsPurchased:
                  type: integer
                totalCouponsRedeemed:
                  type: integer
    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
    CustomerInput:
      type: object
      properties:
        email:
          type: string
          format: email
          maxLength: 255
        contact:
          $ref: '#/components/schemas/Contact'
        address:
          anyOf:
            - $ref: '#/components/schemas/Address'
            - type: 'null'
        birthdate:
          type: string
          format: date-time
        privacyConsentGiven:
          type: boolean
      required:
        - email
        - contact
    Contact:
      type: object
      properties:
        fullName:
          type: string
          maxLength: 200
        displayName:
          type: string
          maxLength: 100
        company:
          type: string
          maxLength: 100
        phone:
          type: string
          maxLength: 20
      required:
        - fullName
    Address:
      type: object
      properties:
        line1:
          type: string
          maxLength: 255
        line2:
          type: string
          maxLength: 255
        city:
          type: string
          maxLength: 100
        state:
          type: string
          maxLength: 100
        postalCode:
          type: string
          maxLength: 20
        countryCode:
          type: string
          description: Two-letter country code.
          minLength: 2
          maxLength: 2
      required:
        - line1
        - city
        - postalCode
        - countryCode
  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.