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

# List customers

> Your workspace's customers, newest first. Filter by `reference` to find the customer you created for one of your users.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /customers
openapi: 3.1.0
info:
  title: Payra API
  version: v1
  description: >-
    The Payra API. Authenticate with a secret key: `Authorization: Bearer
    sk_test_...`. The two payment method session endpoints Payra Elements calls
    also take a publishable key with the session's `client_secret`.
servers:
  - url: https://api-dashboard.payra.com/v1
    description: 'Sandbox and live: the key decides which'
security: []
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        Your workspace's customers, newest first. Filter by `reference` to find
        the customer you created for one of your users.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
            example: 20
            description: How many to return, 1 to 100.
          required: false
          description: How many to return, 1 to 100.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 64
            example: 019e2b4c-7a1d-7c3e-9f20-5b8d4e6a1c30
            description: >-
              The `id` of the last customer of the previous page; the page after
              it is returned.
          required: false
          description: >-
            The `id` of the last customer of the previous page; the page after
            it is returned.
          name: starting_after
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 100
            example: user_48213
            description: 'Only the customer with this `reference`: at most one.'
          required: false
          description: 'Only the customer with this `reference`: at most one.'
          name: reference
          in: query
      responses:
        '200':
          description: A page of customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerList'
        '400':
          description: >-
            `limit` out of range, or `starting_after` is not a customer of this
            workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The API is not enabled for the workspace, or the key lacks the scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    CustomerList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
        has_more:
          type: boolean
      required:
        - object
        - data
        - has_more
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - idempotency_error
                - card_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - request_id
          additionalProperties:
            type: string
      required:
        - error
    Customer:
      type: object
      properties:
        object:
          type: string
          enum:
            - customer
        id:
          type: string
          format: uuid
          example: 019e2b4c-7a1d-7c3e-9f20-5b8d4e6a1c30
          description: >-
            Pass it as `customer` on a payment method session, a checkout
            session or a payment.
        reference:
          type:
            - string
            - 'null'
          example: user_48213
          description: >-
            Your own id for the customer; null for customers created in the
            Payra dashboard or by an ERP.
        name:
          type:
            - string
            - 'null'
          example: Ada Lovelace
          description: >-
            The name shown in the Payra dashboard: the email, or the reference,
            when created without one.
        email:
          type:
            - string
            - 'null'
          example: ada@example.com
        phone:
          type:
            - string
            - 'null'
          example: '+15555550123'
        created_at:
          type: string
          format: date-time
          example: '2026-09-29T14:00:00.000Z'
      required:
        - object
        - id
        - reference
        - name
        - email
        - phone
        - created_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A secret key, `sk_test_...` or `sk_live_...`; a publishable key
        (`pk_...`) on the browser routes only

````