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

# List customers

> Returns a paginated list of customers belonging to the authenticated company, with optional filters.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/customers
openapi: 3.0.0
info:
  title: PlugToPay API
  description: API to make payments easy in multiple gateways.
  version: 1.0.0
servers:
  - url: http://localhost:7701
    description: Test Server
security: []
paths:
  /api/v1/customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        Returns a paginated list of customers belonging to the authenticated
        company, with optional filters.
      operationId: 3ce2972eb0b67885f27d80024dc92295
      parameters:
        - $ref: '#/components/parameters/XClientId'
        - name: name
          in: query
          description: Partial name search
          required: false
          schema:
            type: string
            example: John
        - name: email
          in: query
          description: Partial email search
          required: false
          schema:
            type: string
            example: john@
        - name: token
          in: query
          description: Exact customer vault token
          required: false
          schema:
            type: string
            example: cus_abc123
        - name: document
          in: query
          description: CPF or CNPJ (digits only or formatted)
          required: false
          schema:
            type: string
            example: '12345678909'
        - name: phone
          in: query
          description: Partial phone search (digits only or formatted)
          required: false
          schema:
            type: string
            example: '31994878998'
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            example: 15
        - name: page
          in: query
          required: false
          schema:
            type: integer
            example: 1
      responses:
        '200':
          description: Paginated list of customers
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      type: object
                  meta:
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 42
                      last_page:
                        type: integer
                        example: 3
                    type: object
                type: object
        '401':
          description: Unauthorized — Invalid API Key
        '422':
          description: Validation Error
      security:
        - ApiKeyAuth: []
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      description: Client identifier for the company in the request.
      required: true
      schema:
        type: string
        example: client_abc123
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Company API key. Send in the X-API-Key header.
      name: X-API-Key
      in: header

````