Fetch All Consumers

Retrieves the list of consumers in the organization

Fetch consumers

This endpoint allows an organization to retrieve a paginated list of all consumers registered under it. The API returns consumer records with personal details (e.g., name, ID number, mobile number, country) and system-generated metadata such as consumer ID, status, and timestamps.


Parameters

  • organizationId (path): Your organization ID

Query Parameters

  • page (optional): Page number (default: 0)
  • limit (optional): Items per page (default: 10)

Sample Response

{
    "content": [
        {
            "id": "14ac3424-c9d7-43cc-b76d-ddc3124410c3",
            "firstName": "Oliver",
            "lastName": "Tambo",
            "status": "New",
            "idNumber": "24743579279",
            "mobile": "+254723009900",
            "datetimeCreated": "2025-09-12T05:41:53.000Z",
            "lastModified": "2025-09-12T05:41:53.000Z",
            "country": {
                "id": "KE",
                "shortName": "Kenya"
            },
            "headOffice": {
                "id": "457cc8a6-4774-4e81-a670-64b9c951a142",
                "name": "Bonface&Sons",
                "tradingName": "Bonface&Sons"
            }
        },
        {
            "id": "30127903-64c0-41e2-ab70-f7b9bbe3edbc",
            "firstName": "Brian",
            "lastName": "Oyamo",
            "status": "New",
            "idNumber": "237890654",
            "mobile": "+254793875319",
            "datetimeCreated": "2025-08-28T11:12:43.000Z",
            "lastModified": "2025-08-28T11:12:43.000Z",
            "country": {
                "id": "KE",
                "shortName": "Kenya"
            },
            "headOffice": {
                "id": "457cc8a6-4774-4e81-a670-64b9c951a142",
                "name": "Bonface&Sons",
                "tradingName": "Bonface&Sons"
            }
        }
    ],
    "page": {
        "number": 0,
        "size": 10,
        "totalPages": 1,
        "totalElements": 2
    }
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!