Skip to content
Loading keys…
Authorization<token>

A public key (pk./pk_test.) is accepted on /payments, /customers, /links, /invoices and the catalogue reads (/channels, /providers, /countries, /currencies); anything that moves money out, reads the balance or manages the account answers 406 to it. It is an identifier, never an authorization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment, there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Query Parameters

per_pageinteger | null

Max results per page (1–100). Defaults to 25.

pageinteger

The page to read, from 1, for offset pagination. Ignored with `cursor`.

status"active" | "inactive" | "blocked"

Filter by status (`active`, `inactive`, `blocked`).

"active""inactive""blocked"
type"individual" | "business"

Filter by type (`individual`, `business`).

"individual""business"
countrystring | null

Customers whose shipping or billing address is in this country, by 2-letter code.

cursorstring | null

The `next_cursor` of a previous response, a numbered page included: switches the list to cursor pagination.

customer_groupstring | null

Only the customers of this group.

searchstring | null

Search over the name, business name, email, phone and `id`.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.wajub.com/customers?per_page=10&page=2&status=active&country=CM&customer_group=wholesale&search=amina"
GET
/customers
{  "code": 200,  "status": "OK",  "message": "Customers retrieved",  "items": [    {      "id": "cus_Qe7Tb2Wn5Lr9Xc4Mv8Hk1Zs3",      "email": "amina@example.com",      "name": "Amina Diallo"    }  ],  "meta": {    "current_page": 1,    "last_page": 16,    "per_page": 25,    "total": 156,    "next_cursor": "c_9fK2mQ7vB4nL6hR1xT8w",    "has_more": true  }}

Customers list

What did you think of this content?