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

# List customers

> Returns this partner's customers, newest first. Deleted customers are excluded.



## OpenAPI

````yaml api-reference/endl-onboarding-api.json GET /api/v0/customer
openapi: 3.1.0
info:
  title: Endl Partner Onboarding API
  version: '0'
  description: >-
    Onboard end customers for identity verification — individuals (KYC) and
    businesses (KYB) — through one uniform REST surface.


    Authentication is API-key only: every request carries a single `API-KEY`
    header. Unlike the Partner API, responses are **flat** — a successful body
    is the data object itself, with no `{ data, code, message, status }`
    envelope.
servers:
  - url: https://qa-api.endl.xyz
    description: QA
security:
  - apiKey: []
tags:
  - name: Customers
    description: Create, read, update and delete onboarding customers.
  - name: Documents
    description: Upload identity, company and beneficial-owner documents.
paths:
  /api/v0/customer:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        Returns this partner's customers, newest first. Deleted customers are
        excluded.
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 0
          description: Zero-based page index.
        - name: size
          in: query
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
          description: Page size, clamped to 1–100.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
          description: Optional active / inactive filter.
      responses:
        '200':
          description: A page of customers.
          content:
            application/json:
              example:
                customers:
                  - userId: 6c4ba9af-978a-45ff-953f-729c593f14af
                    userType: INDIVIDUAL
                    status: PENDING
                page: 0
                size: 20
                totalElements: 42
                totalPages: 3
                hasNext: true
                hasPrevious: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: Missing or invalid `API-KEY`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: '401'
            message: Authentication Failed!
            name: PartnerOnboarding failed to process
    Forbidden:
      description: >-
        The key lacks the `onboarding` permission, the customer belongs to
        another partner, or onboarding is not permitted for that country.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: '403'
            message: Onboarding is not permitted for this country
            name: PartnerOnboardingCreate failed to process
    RateLimited:
      description: >-
        The per-partner rate limit was exceeded. This response keeps the older
        envelope shape and carries `X-RateLimit-Limit` and
        `X-RateLimit-Remaining`.
      content:
        application/json:
          example:
            data: null
            code: 429
            message: Rate limit exceeded, please retry later
            status: Error
            errors:
              - code: '429'
                message: Rate limit exceeded, please retry later
                field: Rate limit exceeded, please retry later
  schemas:
    Error:
      type: object
      description: >-
        A single problem. `code` is the HTTP status, `message` the specific
        reason, and `name` the operation that failed.
      properties:
        code:
          type: string
        message:
          type: string
        name:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: API-KEY
      description: Your partner API key. The key must carry the `onboarding` permission.

````