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

> ## Agent Instructions
> Documentação oficial da sinnu, gateway de pagamento brasileiro: Pix e cartão de crédito. O índice de todas as páginas está em https://docs.sinnu.com.br/llms.txt.
> A API (https://api.sinnu.com.br) e o checkout (https://pay.sinnu.com.br) documentados são de produção. Não há ambiente público de testes: cada chamada cria ou altera dados reais.
> A chave secreta sk_live_ fica só no servidor. O navegador recebe apenas o slug do link ou a URL do checkout.
> Unidades: amountCents do link e os valores de /api/transactions/ estão em centavos (inteiro). data.amount do webhook e amount das transações de um link estão em reais. Compare na mesma unidade.
> Status: a API de transações usa approved; o corpo do webhook usa paid; o evento é transaction.approved.
> Libere o pedido só pelo webhook assinado (X-Sinnu-Signature, validado sobre o corpo cru com constructEvent({ payload, signature, secret })) e confirme com transactions.get. Nunca pelo evento completed do Sinnu Elements nem pelos parâmetros da URL de retorno.
> Estorno é sempre do valor total. Não invente métodos, campos ou eventos: confira na referência do SDK e da API.

# Liste clientes

> Consulte os clientes da empresa autenticada.

A empresa é determinada pela chave de API. Use os identificadores retornados para buscar os detalhes.


## OpenAPI

````yaml GET /api/customers/
openapi: 3.0.3
info:
  title: sinnu API
  version: 1.0.0
  description: >-
    API pública da sinnu para links, clientes e transações. Autentique com
    Bearer e a chave da empresa. Links usam amountCents em centavos; a API de
    transações usa centavos; webhooks e transações de um link usam reais.
    Consulte a unidade de cada recurso.
  x-source-sha256: 153c3fdb10dbb3d93407364e1d121b9565747a56c1b8db9ace49edcb2ef48d8a
servers:
  - url: https://api.sinnu.com.br
    description: Produção
security:
  - bearerAuth: []
paths:
  /api/customers/:
    get:
      tags:
        - customers
      summary: Listar clientes
      description: >-
        Lista os clientes da empresa autenticada no envelope paginado `{ data,
        total, page, pageSize }`.
      operationId: customers_list
      parameters:
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - in: query
          name: page
          schema:
            type: integer
          description: Número da página (1-based; default 1).
        - in: query
          name: pageSize
          schema:
            type: integer
          description: Tamanho da página (default 20, máx. 100).
        - in: query
          name: search
          schema:
            type: string
          description: Busca por nome, e-mail, telefone ou documento.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSinnuCustomerList'
          description: ''
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl --fail-with-body --request GET \
              'https://api.sinnu.com.br/api/customers/' \
              --header "Authorization: Bearer $SINNU_API_KEY"
        - lang: javascript
          label: JavaScript · servidor
          source: >-
            const apiKey = process.env.SINNU_API_KEY;

            if (!apiKey) throw new Error("Configure SINNU_API_KEY no
            servidor.");

            const response = await
            fetch("https://api.sinnu.com.br/api/customers/", {
              method: "GET",
              headers: {
                Authorization: `Bearer ${apiKey}`,
              },
            });

            if (!response.ok) throw new Error(`HTTP ${response.status}: ${await
            response.text()}`);

            console.log(response.status === 204 ? null : await response.json());
components:
  schemas:
    PaginatedSinnuCustomerList:
      type: object
      required:
        - data
        - total
        - page
        - pageSize
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SinnuCustomer'
        total:
          type: integer
          example: 123
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 20
      example:
        data:
          - id: 00000000-0000-4000-8000-000000000002
            name: Cliente de exemplo
            email: cliente@example.com
            phone: '11999999999'
            document: null
            type: pf
            createdAt: '2026-09-01T12:00:00.000Z'
            address: null
            notes: null
        total: 1
        page: 1
        pageSize: 20
    SinnuCustomer:
      type: object
      description: >-
        Cliente da sua empresa. Expõe apenas os dados principais de cadastro e
        um único documento principal (CPF ou CNPJ).
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
          maxLength: 255
        email:
          type: string
          format: email
          maxLength: 254
        phone:
          type: string
          description: Telefone do cliente com DDD (opcional no cadastro).
          maxLength: 255
        document:
          type: string
          nullable: true
          description: >-
            Documento principal do cliente: CPF ou CNPJ, somente dígitos ou
            formatado.
        type:
          allOf:
            - $ref: '#/components/schemas/SinnuCustomerTypeEnum'
          description: 'Tipo do documento principal: `pf` para CPF ou `pj` para CNPJ.'
        createdAt:
          type: string
          format: date-time
          readOnly: true
        address:
          type: string
          nullable: true
          description: Endereço em linha livre, opcional.
        notes:
          type: string
          nullable: true
          description: Observações internas sobre o cliente, opcionais.
          maxLength: 500
        archivedAt:
          type: string
          format: date-time
          readOnly: true
        anonymizedAt:
          type: string
          format: date-time
          readOnly: true
      required:
        - anonymizedAt
        - archivedAt
        - createdAt
        - email
        - id
        - name
      example:
        id: 00000000-0000-4000-8000-000000000002
        name: Cliente de exemplo
        email: cliente@example.com
        phone: '11999999999'
        document: null
        type: pf
        createdAt: '2026-09-01T12:00:00.000Z'
        address: null
        notes: null
    SinnuCustomerTypeEnum:
      enum:
        - pf
        - pj
      type: string
      description: |-
        * `pf` - pf
        * `pj` - pj
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave secreta sk_live_ da empresa. Use somente no servidor.

````

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