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

# List customers

> Lists the business's customers, newest first. Filter by status, name search, phone, email, KYC tier or creation date; page with the cursor.

**Required permission:** `feature:CUSTOMERS`, `customers:read`



## OpenAPI

````yaml /api-reference/openapi.json get /v1/customers
openapi: 3.0.4
info:
  title: Mesh API
  description: >-
    The bank's developer API. Merchants create and manage customers and verify
    identities.


    **Authentication.** Every call sends `X-Api-Key`, from an IP on that key's
    allowlist. One URL serves both

    modes: an `lsk_test_` key reaches the sandbox, an `lsk_live_` key the bank.


    **Answers.** Every response is `{ success, data, message, request_id }`,
    plus a numeric `code` on failure

    (`13` validation, `14` no key, `15` no permission, `43` feature off,
    `50`-`55` customers; the full list is

    in docs/error-codes.md). Fields are snake_case; empty fields are left out.


    **Creating.** `POST`s that create something need an `Idempotency-Key`
    header. Retrying with the same key

    and body returns the first answer with `Idempotent-Replayed: true`.


    **Lists.** Newest first, at most 100 a page (20 by default). Pass
    `next_cursor` back as `cursor`.
  version: v1
servers:
  - url: https://{host}
    description: 'Your bank''s Mesh URL. One URL serves test and live: the key decides.'
    variables:
      host:
        default: mesh.your-bank.com
        description: Your bank's Mesh host
security:
  - ApiKey: []
tags:
  - name: Status
    description: 'Check a key: its business, mode and permissions.'
  - name: Reference data
    description: Countries and customer types the API accepts.
  - name: Customers
    description: The people a wallet business serves. Needs the wallet product.
  - name: Verifications
    description: 'Identity and business checks: BVN, NIN, CAC, TIN, name enquiry and more.'
  - name: Wallets
    description: 'Accounts that hold money in Purse: the business''s own and its customers''.'
  - name: Virtual accounts
    description: >-
      Numbers your payers pay into: static collection accounts and dynamic
      one-payment accounts.
  - name: Payments
    description: Payments into a virtual account, including held ones.
  - name: Accounts
    description: Balance, history and limits of one account, by its number.
  - name: Business transactions
    description: Every transaction across all your accounts.
  - name: Settlement accounts
    description: Your accounts at the bank, where collections settle.
  - name: Number patterns
    description: Blocks of account numbers the bank gave your business.
  - name: Collection settlements
    description: Payments passed on to your settlement account.
  - name: Charges
    description: What the bank charged you, by service.
  - name: Transfers
    description: Move money between wallets, or out to another bank.
  - name: Settlements
    description: Withdraw to your own bank account.
  - name: Banks
    description: Bank codes for interbank transfers.
  - name: Account names
    description: The name on an account, before you pay it.
  - name: Simulations
    description: 'Test mode only: send a pretend payment into a sandbox account.'
  - name: Events
    description: Poll the events your webhooks carry.
  - name: Webhook endpoint
    description: Where Mesh sends your events, and its signing secret.
  - name: Webhook deliveries
    description: Every delivery attempt, and replays.
paths:
  /v1/customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: >-
        Lists the business's customers, newest first. Filter by status, name
        search, phone, email, KYC tier or creation date; page with the cursor.


        **Required permission:** `feature:CUSTOMERS`, `customers:read`
      parameters:
        - name: status
          in: query
          schema:
            type: string
        - name: search
          in: query
          schema:
            type: string
        - name: phone_number
          in: query
          schema:
            type: string
        - name: email
          in: query
          schema:
            type: string
        - name: kyc_tier
          in: query
          schema:
            type: integer
            format: int32
        - name: from
          in: query
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          schema:
            type: string
            format: date-time
        - name: cursor
          in: query
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPageDtoApiResponse'
        '401':
          description: Authentication is required
        '403':
          description: The caller lacks permission
      security:
        - ApiKey: []
components:
  schemas:
    CustomerPageDtoApiResponse:
      required:
        - message
        - request_id
        - success
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/CustomerPageDto'
        message:
          type: string
          nullable: true
        request_id:
          type: string
          nullable: true
          example: 01a1775167aa7693a7acd8df7b596118
        code:
          type: string
          description: >-
            Failures only: the numeric code a client branches on (see
            ErrorCodeNumbers).
          nullable: true
          example: '13'
      additionalProperties: false
    CustomerPageDto:
      required:
        - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CustomerSummaryDto'
          nullable: true
        next_cursor:
          type: string
          nullable: true
      additionalProperties: false
    CustomerSummaryDto:
      required:
        - customer_type
        - date_created
        - first_name
        - id
        - kyc_status
        - kyc_tier
        - last_name
        - phone_number
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        customer_type:
          type: string
          nullable: true
          example: individual
        first_name:
          type: string
          nullable: true
          example: Adaeze
        last_name:
          type: string
          nullable: true
          example: Okafor
        email:
          type: string
          nullable: true
          example: adaeze.okafor@example.com
        phone_number:
          type: string
          nullable: true
          example: '+2348012345678'
        alias:
          type: string
          nullable: true
          example: Mama Ada
        kyc_tier:
          type: integer
          format: int32
        kyc_status:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        date_created:
          type: string
          format: date-time
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      description: >-
        An API key: lsk_<test|live>_<public_id>.<secret>. The key also has to be
        used from an address on its allowlist.
      name: X-Api-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.