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

# List Customers



## OpenAPI

````yaml GET /customers
openapi: 3.0.3
info:
  title: Atlas API
  description: >
    Processor-agnostic payment orchestration API with Basis Theory for PCI-free
    tokenization.


    ## Authentication


    All API requests require authentication using an API key in the
    `Authorization` header:

    ```

    Authorization: Bearer sk_test_your_api_key

    ```


    ## Payment Methods


    Atlas supports multiple payment methods:

    - **Card**: Credit and debit cards tokenized via Basis Theory

    - **Apple Pay**: Native Apple Pay integration

    - **Google Pay**: Native Google Pay integration

    - **Bank Account (ACH)**: US bank account payments


    ## Environments


    - **Test**: Use `sk_test_` prefixed keys

    - **Live**: Use `sk_live_` prefixed keys
  version: 1.0.0
  contact:
    name: Atlas Support
    url: https://atlas.co/support
servers:
  - url: https://api.atlas.co/functions/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Sessions
    description: Payment session management
  - name: Payments
    description: Payment confirmation and processing
  - name: Customers
    description: Customer management
  - name: Products
    description: Product catalog management
  - name: Prices
    description: Price configuration
  - name: Subscriptions
    description: Subscription billing
  - name: Invoices
    description: Invoice management
  - name: Coupons
    description: Discount coupons
  - name: Usage Records
    description: Metered billing usage
  - name: Checkout
    description: Hosted checkout pages
  - name: Portal
    description: Customer self-service portal
  - name: Bank Accounts
    description: ACH bank account management
  - name: Identity Vault
    description: PII tokenization and storage
  - name: KYC
    description: Identity verification
  - name: Ledger
    description: Double-entry ledger accounting
  - name: 3D Secure
    description: 3DS authentication
  - name: Network Tokens
    description: Network token management
  - name: Apple Pay
    description: Apple Pay integration
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List Customers
      operationId: listCustomers
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - name: email
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Customer list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerList'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 10
        maximum: 100
    Offset:
      name: offset
      in: query
      schema:
        type: integer
        default: 0
  schemas:
    CustomerList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
        has_more:
          type: boolean
        total_count:
          type: integer
    Customer:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - customer
        email:
          type: string
        name:
          type: string
        phone:
          type: string
        description:
          type: string
        billing_address:
          $ref: '#/components/schemas/Address'
        shipping_address:
          $ref: '#/components/schemas/Address'
        default_payment_method:
          type: string
        tax_exempt:
          type: boolean
        tax_ids:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              value:
                type: string
        metadata:
          type: object
          additionalProperties:
            type: string
        created:
          type: integer
    Address:
      type: object
      properties:
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: API key (sk_test_* or sk_live_*)

````