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

# Read all customers

> This endpoint reads all customers.



## OpenAPI

````yaml /openapi/api-production.yaml get /customers
openapi: 3.1.0
info:
  version: 1.0.0
  title: Lumx API
  description: >-
    A cross-border banking API with instant settlements and unmatched liquidity,
    powered by stablecoins.
servers:
  - url: https://api.lumx.io
  - url: https://api-sandbox.lumx.io
security: []
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: Read all customers
      description: This endpoint reads all customers.
      parameters:
        - name: size
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Number of customers to return per page.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Cursor for pagination. Use the nextCursor or previousCursor from the
            previous response to get the next or previous page.
      responses:
        '200':
          description: Resources successfully retrieved.
          content:
            application/json:
              examples:
                Business:
                  $ref: '#/components/examples/CustomerBusinessArrayExample'
              schema:
                type: object
                properties:
                  data:
                    description: An array containing all customers.
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerArrayResponse'
                  pagination:
                    type: object
                    description: Pagination metadata for the response.
                    properties:
                      size:
                        type: integer
                        description: Number of items per page.
                        example: 25
                      total:
                        type: integer
                        description: Total number of items available.
                        example: 1
                      hasNextPage:
                        type: boolean
                        description: Whether more items are available after this page.
                        example: false
                      hasPreviousPage:
                        type: boolean
                        description: Whether items are available before this page.
                        example: false
                      nextCursor:
                        type: string
                        format: uuid
                        nullable: true
                        description: >-
                          Cursor to fetch the next page. `null` when
                          `hasNextPage` is false.
                        example: null
                      previousCursor:
                        type: string
                        format: uuid
                        nullable: true
                        description: >-
                          Cursor to fetch the previous page. `null` when
                          `hasPreviousPage` is false.
                        example: null
      security:
        - apiKey: []
components:
  examples:
    CustomerBusinessArrayExample:
      value:
        data:
          - id: 3c90c3cc-0d44-4b50-8888-8dd25736052a
            type: BUSINESS
            legalName: Lumx S.A
            taxId: 42.887.120/0001-00
            incorporationDate: '2020-01-01'
            country: BRA
            email: hello@lumx.io
            verification:
              status: NOT_STARTED
              level: STANDARD
              link: https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44
            metadata: {}
            createdAt: '2021-01-01T00:00:00Z'
            updatedAt: '2021-01-01T00:00:00Z'
        pagination:
          size: 25
          total: 1
          hasNextPage: false
          hasPreviousPage: false
          nextCursor: null
          previousCursor: null
  schemas:
    CustomerArrayResponse:
      allOf:
        - type: object
          properties:
            id:
              type: string
              description: Customer's unique identifier.
              format: uuid
              example: 3c90c3cc-0d44-4b50-8888-8dd25736052a
        - $ref: '#/components/schemas/CustomerBusiness'
        - $ref: '#/components/schemas/CustomerArrayResponseFields'
    CustomerBusiness:
      title: Business
      type: object
      properties:
        type:
          type: string
          description: Customer's type.
          enum:
            - BUSINESS
        legalName:
          type: string
          description: Customer's legal name.
          example: Lumx S.A
        taxId:
          type: string
          description: >-
            Customer's tax ID. It must be a valid tax ID in the country where
            the company is incorporated.
          example: 42.887.120/0001-00
        incorporationDate:
          type: string
          description: Customer's incorporation date.
          format: date
          example: '2020-01-01'
        country:
          type: string
          description: Customer's country (ISO 3166-1 alpha-3).
          example: BRA
        email:
          type: string
          description: Customer's email.
          example: hello@lumx.io
        metadata:
          type: object
          description: >-
            Optional metadata object to attach to the customer. Accepts any
            valid JSON object.
          additionalProperties: true
          example:
            externalId: biz_456
            tier: enterprise
    CustomerArrayResponseFields:
      type: object
      properties:
        taxId:
          description: Customer's tax ID.
        verification:
          $ref: '#/components/schemas/CustomerVerification'
        metadata:
          type: object
          description: >-
            Custom metadata associated with the customer. Returns an empty
            object if no metadata was provided.
          additionalProperties: true
          example:
            externalId: usr_123
            tier: premium
        createdAt:
          type: string
          description: Creation date and time (UTC).
          format: date-time
          example: '2021-01-01T00:00:00Z'
        updatedAt:
          type: string
          description: Last update date and time (UTC).
          format: date-time
          example: '2021-01-01T00:00:00Z'
    CustomerVerification:
      type: object
      description: Customer's verification.
      properties:
        status:
          type: string
          description: Verification status.
          enum:
            - NOT_STARTED
            - UNDER_VERIFICATION
            - APPROVED
            - TEMPORARY_REJECTION
            - FINAL_REJECTION
          example: NOT_STARTED
        level:
          type: string
          description: Verification level.
          enum:
            - STANDARD
          example: STANDARD
        link:
          type: string
          description: Verification link.
          example: https://in.sumsub.com/websdk/p/sbx_aA00bB11cC33dD44
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Bearer authentication header on the format `Bearer <API_KEY>`.

````