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

# List all customers

> Returns business customers (entities with their team members) and/or individual customers (users without an entity).
Use the `customer_type` query parameter to filter:
- `business`: only business customers
- `individual`: only individual customers
- `all` (default): both business and individual customers



## OpenAPI

````yaml /api-reference/openapi-integrator.json get /v1/query/get-customers
openapi: 3.0.3
info:
  title: Byzantine Integrator API
  description: Byzantine REST API for integrators.
  license:
    name: ''
  version: 0.2.0
servers:
  - url: https://sandbox.api.byzantine.fi
    description: Sandbox
security: []
tags:
  - name: API health
    description: Check API status.
  - name: Customer management
    description: Endpoints to create, update, and retrieve customer information.
  - name: Account management
    description: Endpoints to manage accounts, bank accounts, invitations, and user roles.
  - name: Products
    description: Endpoints to get data about products and vaults.
  - name: Transactions
    description: Endpoints to create and manage transactions.
  - name: OTP authentication
    description: Endpoints to initialize and manage user authentication with OTP.
  - name: Webhooks
    description: Integrator-managed outbound webhook subscriptions and delivery history.
paths:
  /v1/query/get-customers:
    get:
      tags:
        - Customer management
      summary: List all customers
      description: >-
        Returns business customers (entities with their team members) and/or
        individual customers (users without an entity).

        Use the `customer_type` query parameter to filter:

        - `business`: only business customers

        - `individual`: only individual customers

        - `all` (default): both business and individual customers
      operationId: get_customers
      parameters:
        - name: X-Pubkey
          in: header
          description: >-
            Integrator's ECDSA public key (P-256 curve, compressed SEC1 format).
            Example:
            0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd
          required: true
          schema:
            type: string
        - name: X-Timestamp
          in: header
          description: >-
            Unix timestamp in seconds (UTC). Must be within tolerance window (1
            minute) to prevent replay attacks. Example: 1760375826
          required: true
          schema:
            type: string
        - name: X-Signature
          in: header
          description: >-
            ECDSA signature (DER-encoded, hex with 0x prefix). Signs the
            message: {timestamp}{METHOD}{path_and_query}{json_body}. Example:
            0x3045022100...
          required: true
          schema:
            type: string
        - name: customerType
          in: query
          description: >-
            Filter by customer type: "business", "individual", or "all"
            (default: "all")
          required: false
          schema:
            $ref: '#/components/schemas/CustomerQueryType'
      responses:
        '200':
          description: Customers retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCustomersResponse'
        '500':
          description: Internal server error
      security:
        - integrator_auth: []
components:
  schemas:
    CustomerQueryType:
      type: string
      description: Filter type for the get-customers endpoint
      enum:
        - business
        - individual
        - all
    GetCustomersResponse:
      type: object
      description: Response body for the get-customers endpoint
      properties:
        businessCustomers:
          type: array
          items:
            $ref: '#/components/schemas/BusinessCustomer'
          nullable: true
        individualCustomers:
          type: array
          items:
            $ref: '#/components/schemas/IndividualCustomer'
          nullable: true
    BusinessCustomer:
      type: object
      description: A business customer (entity) with its team members
      required:
        - entityId
        - entityName
        - verificationStatus
        - createdAt
        - updatedAt
        - teamMembers
      properties:
        entityId:
          $ref: '#/components/schemas/Uuid'
        entityName:
          type: string
        verificationStatus:
          $ref: '#/components/schemas/VerificationStatus'
        logoUrl:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        teamMembers:
          type: array
          items:
            $ref: '#/components/schemas/EntityMember'
    IndividualCustomer:
      type: object
      description: An individual customer
      required:
        - userId
        - firstName
        - lastName
        - email
        - verificationStatus
        - createdAt
        - updatedAt
      properties:
        userId:
          $ref: '#/components/schemas/Uuid'
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        verificationStatus:
          $ref: '#/components/schemas/VerificationStatus'
        logoUrl:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Uuid:
      type: string
      format: uuid
      description: A UUID string
      example: 550e8400-e29b-41d4-a716-446655440000
    VerificationStatus:
      type: string
      description: The identity verification status of the user.
      enum:
        - not_started
        - init
        - under_review
        - awaiting_associated_person_information
        - awaiting_information
        - resubmission_requested
        - active
        - rejected
        - inactive
      example: active
    EntityMember:
      type: object
      description: A customer member (user or team member)
      required:
        - userId
        - firstName
        - lastName
        - email
      properties:
        userId:
          $ref: '#/components/schemas/Uuid'
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
  securitySchemes:
    integrator_auth:
      type: apiKey
      in: header
      name: X-Pubkey, X-Timestamp, X-Signature

````