Skip to navigation
Customers

List Customers

View as Markdown

List customers under your company, with optional search and pagination.

Query parameters

FieldTypeRequiredNotes
pageintegernoDefault 1
pageSizeintegernoDefault 20, capped at 20
searchstringnoMatches email, firstName, lastName (case-insensitive contains) or bvn (contains)

Behaviour notes

  • Each item has only id, firstName and lastName, newest first.
  • The response envelope differs from the other endpoints: success: true (boolean) instead of status: "success", and meta.total instead of meta.totalItems.
  • Errors return 400 { "success": false, "message": "Server error" }.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Query parameters

pagestringOptional
Optional. Defaults to 1.
pageSizestringOptional
Optional. Defaults to 20.
searchstringOptional
Optional. Search term.

Response

OK
successbooleanOptional
datalist of objectsOptional
metaobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error