HOhoneycoin

Get All Customers

Changed on

This API retrieves a list of customers with support for pagination. Forward pagination: Pass the customerId of the last customer in the current list. Backward pagination: Pass the customerId and set startAfter to false. Limit (optional): Specifies the number of customers to retrieve. Defaults to 20. Maximum is 100.

get/api/b2b/customers

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/customers
  • Auth
    API key in header Authorization

Path parameters

customerIdstring required
startAfterboolean required

Set to false to perform backward pagination and true to perform forward pagination. must be accompanied by the customerId.

limitinteger required

Number of records to retrieve

Response

200

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "country": "NG",
      "createdAt": 1730969823000,
      "profilePicture": "https://imagedelivery.net/XYPCTx1RfzadZ3NdvQYJrQ/59f5c971-0449-478c-6363-309103417600/public",
      "customerType": "business",
      "companyName": "Ace Chemicals",
      "customerId": "nmbjbjbhvhbal",
      "currency": "NGN",
      "email": "ace@gmail.com",
      "status": "ACTIVE"
    }
  ]
}

Changes