List Customers

Get all the customers on your account

Retrieves a paginated list of your customers.

Retrieves all customers for a merchant profile

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Query parameters

searchstringOptional

Search parameter to use while filtering the list

pageinteger · int32Optional

The target page to retrieve if available. Minimum value is 1.

page_sizeinteger · int32Optional

Required page size. Acceptable range is from 1 to 100.

show_shadow_deletedbooleanOptional

statusstring · enumOptionalPossible values:

start_datestring · date-timeOptional

end_datestring · date-timeOptional

Responses

200

Returns 200 and a paged response containing the customers

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

is_errorbooleanRead-onlyOptional

400

Returns 400 if the query is invalid

401

Returns 401 when authorization details is invalid

get

/v1/customers

HTTPcURLJavaScriptPython

GET /v1/customers HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": "success",
  "message": "text",
  "data": {
    "id": "text",
    "full_name": "text",
    "email": "text",
    "phone_number": "text",
    "address": "text",
    "status": "active",
    "created_at": "2026-04-03T20:54:12.120Z",
    "edited_at": "2026-04-03T20:54:12.120Z",
    "dedicated_virtual_accounts": [
      {
        "id": "text",
        "is_live": true,
        "account_reference": "text",
        "gateway_code": "text",
        "callback_url": "text",
        "account_name": "text",
        "account_number": "text",
        "country": "text",
        "bank_code": "text",
        "bank_name": "text",
        "currency": "text",
        "bvn": "text",
        "metadata": "text",
        "created_at": "2026-04-03T20:54:12.120Z",
        "edited_at": "2026-04-03T20:54:12.120Z",
        "customer_id": "text",
        "payout_tag": "text",
        "payout_tag_description": "text",
        "payout_tag_metadata": "text"
      }
    ]
  },
  "meta": {
    "page_meta": {
      "page_count": 1,
      "item_count": 1,
      "search": "text",
      "page": 1,
      "page_size": 1
    }
  },
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}