Skip to main content
GET
Customers

Overview

This endpoint retrieves a list of customers with pagination and optional filtering by gender, email, bvn, or phone.

Request

Method: GET URL: /v1/customers

Parameters

Response

Status Code: 200 OK Content-Type: application/json

Example Response

Response Fields

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Query Parameters

page
integer
limit
integer
gender
string

Filter by gender (e.g. MALE, FEMALE)

email
string

Filter by customer email address

bvn
string

Filter by Bank Verification Number

phone
string

Filter by phone number

Response

200 - application/json

OK

The response is of type object.