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

# List customers

> Returns customers for the organization and environment tied to the API key.



## OpenAPI

````yaml /openapi/v1.yaml get /customers
openapi: 3.1.0
info:
  title: Payoes API
  version: 1.0.0
  description: >
    REST API for creating and managing Stellar payments, customers, checkout
    sessions,

    payment links, and invoices.


    ## Authentication


    Send your API key as a Bearer token. Sandbox keys use the `pk_test_` prefix
    and

    only access sandbox data. Live keys use `pk_live_` and only access
    production data.


    ## Environments


    Sandbox and production are fully isolated. Resources created in one
    environment

    are not visible from API keys scoped to the other.
servers:
  - url: https://payoes.com/api/v1
    description: Production host (replace with your deployment URL)
  - url: http://localhost:3000/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Payments
    description: Direct payment intents with hosted Stellar checkout
  - name: Customers
    description: Payer profiles scoped to your organization and environment
  - name: Checkout sessions
    description: Hosted checkout flows with optional redirect URLs
  - name: Payment links
    description: Reusable shareable links that start checkout on each visit
  - name: Invoices
    description: Customer invoices with draft, finalize, and checkout lifecycle
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        Returns customers for the organization and environment tied to the API
        key.
      operationId: listCustomers
      responses:
        '200':
          description: Customer list
          content:
            application/json:
              schema:
                type: object
                required:
                  - customers
                properties:
                  customers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Customer'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Customer:
      type: object
      required:
        - id
        - environment
        - created_at
        - updated_at
      properties:
        id:
          type: string
          example: cus_abc123xyz
        email:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        primary_stellar_address:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
        metadata:
          $ref: '#/components/schemas/StringMetadata'
        environment:
          $ref: '#/components/schemas/Environment'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    StringMetadata:
      type: object
      additionalProperties:
        type: string
      nullable: true
    Environment:
      type: string
      enum:
        - sandbox
        - production
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the Payoes dashboard (`pk_test_...` or `pk_live_...`)

````