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

# List all customers

> Retrieve a paginated list of all customers. Filter and search through your customer base.



## OpenAPI

````yaml get /v1/customers/list
openapi: 3.0.0
info:
  title: Creem API
  description: >-
    Creem is an all-in-one platform for managing subscriptions and recurring
    revenue, tailored specifically for today's SaaS companies. It enables you to
    boost revenue, enhance customer retention, and scale your operations
    seamlessly.
  version: v1
  contact:
    name: Creem Support
    url: https://creem.io
    email: support@creem.io
  license:
    name: Commercial
    url: https://creem.io/terms
  termsOfService: https://creem.io/terms
servers:
  - url: https://api.creem.io
    description: Production — live API for processing real transactions and data.
    x-speakeasy-server-id: prod
  - url: https://test-api.creem.io
    description: Test — sandbox API for development and testing with no real charges.
    x-speakeasy-server-id: test
security: []
tags: []
externalDocs:
  description: Creem Documentation
  url: https://docs.creem.io
paths:
  /v1/customers/list:
    get:
      tags:
        - Customers
      summary: List all customers
      description: >-
        Retrieve a paginated list of all customers. Filter and search through
        your customer base.
      operationId: listCustomers
      parameters:
        - name: page_number
          required: false
          in: query
          description: The page number for pagination.
          schema:
            default: 1
            example: 1
            type: number
        - name: page_size
          required: false
          in: query
          description: The number of items per page.
          schema:
            default: 50
            example: 50
            type: number
      responses:
        '200':
          description: Successfully retrieved customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListEntity'
        '400':
          description: Bad Request - Invalid input parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Resource does not exist
      security:
        - ApiKey: []
components:
  schemas:
    CustomerListEntity:
      type: object
      properties:
        items:
          description: List of customer items
          items:
            $ref: '#/components/schemas/CustomerEntity'
          type: array
        pagination:
          description: Pagination details for the list
          allOf:
            - $ref: '#/components/schemas/PaginationEntity'
      required:
        - items
        - pagination
    CustomerEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object.
        mode:
          $ref: '#/components/schemas/EnvironmentMode'
        object:
          type: string
          description: >-
            String representing the object’s type. Objects of the same type
            share the same value.
        email:
          type: string
          description: Customer email address.
          example: user@example.com
        name:
          type: string
          description: Customer name.
          example: John Doe
          nullable: true
        metadata:
          type: object
          description: Additional metadata associated with the customer.
          example:
            key: value
          additionalProperties: true
          nullable: true
        country:
          type: string
          description: The ISO 3166-1 alpha-2 country code for the customer.
          example: US
          pattern: ^[A-Z]{2}$
          nullable: true
        created_at:
          format: date-time
          type: string
          description: Creation date of the customer
          example: '2023-01-01T00:00:00Z'
        updated_at:
          format: date-time
          type: string
          description: Last updated date of the customer
          example: '2023-01-01T00:00:00Z'
      required:
        - id
        - mode
        - object
        - email
        - country
        - created_at
        - updated_at
    PaginationEntity:
      type: object
      properties:
        total_records:
          type: number
          description: Total number of records in the list
          example: 0
        total_pages:
          type: number
          description: Total number of pages available
          example: 0
        current_page:
          type: number
          description: The current page number
          example: 1
        next_page:
          type: number
          description: The next page number, or null if there is no next page
          example: 2
          nullable: true
        prev_page:
          type: number
          description: The previous page number, or null if there is no previous page
          example: null
          nullable: true
      required:
        - total_records
        - total_pages
        - current_page
        - next_page
        - prev_page
    EnvironmentMode:
      type: string
      description: String representing the environment.
      enum:
        - test
        - prod
        - sandbox
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can find your API key in the Creem
        dashboard under Settings > API Keys.

````