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

# List customers

> Referencia detallada para GET /v1/customer-hub/customers.

## Uso

Usalo para administrar perfiles de cliente del Customer Hub ("Clientes"), el CRM tenant-scoped y agnostico de SimplePay.

## Antes de llamar

| Tema             | Detalle                                 |
| ---------------- | --------------------------------------- |
| Metodo           | `GET`                                   |
| Ruta             | `/v1/customer-hub/customers`            |
| Auth             | Bearer API key del ambiente correcto.   |
| Scope            | `customer_hub:read`                     |
| Idempotencia     | No aplica para lecturas.                |
| Guia relacionada | [Customer Hub](/api-reference/overview) |

## Patron recomendado

* Ejecuta esta lectura desde backend cuando incluya datos privados del tenant.
* Consulta el bloque OpenAPI de esta pagina para el shape exacto de parametros, body y respuestas.

## Ejemplo minimo

```bash terminal theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -sS "https://api.simplepay.mx/v1/customer-hub/customers" \
  -H "Authorization: Bearer $SIMPLEPAY_API_KEY"
```

## Errores a manejar

* `400` indica payload, parametros o estado invalido.
* `401` o `403` indican API key, ambiente o scopes incorrectos.
* `429` y `5xx` se pueden reintentar con backoff; en writes conserva la misma idempotency key.

## Contrato OpenAPI

El playground, parametros, body y respuestas de abajo salen de `/openapi.json`. Si el contrato cambia, actualiza la spec y regenera esta pagina.


## OpenAPI

````yaml openapi.json GET /v1/customer-hub/customers
openapi: 3.1.0
info:
  title: SimplePay API
  version: '2026-06-13'
servers:
  - url: https://api.simplepay.mx
security:
  - SimplePayApiKey: []
paths:
  /v1/customer-hub/customers:
    get:
      summary: List customers
      operationId: listCustomerHubCustomers
      responses:
        '200':
          description: Customer Hub customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerHubResponse'
components:
  schemas:
    CustomerHubResponse:
      type: object
      description: >-
        Customer Hub response object as returned by the owning origin Worker
        (customer, contact, address, relationship, timeline event, note,
        external ref, provider-sync result, link result, tag, import, sync
        source, or list envelope).
      additionalProperties: true
  securitySchemes:
    SimplePayApiKey:
      type: http
      scheme: bearer

````