> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # List customers > Returns one page of the customer directory. Reach for this to FIND a customer when you only know a tier or need to browse; when you already hold an id, call `getCustomer` instead. Filter with `tier` (the loyalty tier label, e.g. `Or`), order with `sortField` (`name`/`spend`/`points`) + `sortDirection`, and walk the base with `page`/`pageSize` (max 100) until `page` reaches `pageCount`. `spend` is a currency amount, `points` the loyalty balance. ## OpenAPI ````yaml /openapi.json get /v1/customers openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/customers: get: tags: - Customers summary: List customers description: >- Returns one page of the customer directory. Reach for this to FIND a customer when you only know a tier or need to browse; when you already hold an id, call `getCustomer` instead. Filter with `tier` (the loyalty tier label, e.g. `Or`), order with `sortField` (`name`/`spend`/`points`) + `sortDirection`, and walk the base with `page`/`pageSize` (max 100) until `page` reaches `pageCount`. `spend` is a currency amount, `points` the loyalty balance. operationId: listCustomers parameters: - schema: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 in: query name: page required: false - schema: type: integer minimum: 0 exclusiveMinimum: true maximum: 100 in: query name: pageSize required: false - schema: type: string minLength: 1 in: query name: tier required: false - schema: type: string enum: - name - spend - points in: query name: sortField required: false - schema: type: string enum: - asc - desc in: query name: sortDirection required: false responses: '200': description: A page of customer records with the pagination totals. content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 email: type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ phone: type: string tier: type: string minLength: 1 postalCode: type: string addressLine: type: string points: default: 0 type: integer minimum: 0 maximum: 9007199254740991 spend: default: 0 type: number minimum: 0 orders: default: 0 type: integer minimum: 0 maximum: 9007199254740991 optIn: default: false type: boolean required: - id - name - tier - points - spend - orders - optIn additionalProperties: false total: type: integer minimum: -9007199254740991 maximum: 9007199254740991 page: type: integer minimum: -9007199254740991 maximum: 9007199254740991 pageSize: type: integer minimum: -9007199254740991 maximum: 9007199254740991 pageCount: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - items - total - page - pageSize - pageCount additionalProperties: false description: A page of customer records with the pagination totals. example: items: - id: cust-1 name: Camille Renard email: camille.renard@example.com phone: 06 12 34 56 78 tier: Or postalCode: '75011' points: 1240 spend: 842.5 orders: 17 optIn: true total: 15 page: 1 pageSize: 20 pageCount: 1 '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same `pos.*` scope vocabulary the route guards enforce. ````