List Customers

GET

/baseurl/api/v1/Customers

Returns a paginated list of all customers.

Request

Query Params

Header Params

Responses

🟢200

application/json

Body

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/baseurl/api/v1/Customers?limit&offset&status&type&search&createdFrom&createdTo' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'

Response Example

{
    "data": [
        {
            "id": "cst_789012",
            "type": "business",
            "firstName": null,
            "lastName": null,
            "email": "contact@acme.com",
            "phoneCode": "+91",
            "phoneNumber": "9123456789",
            "country": "India",
            "status": "Active",
            "businessName": "Acme Pvt Ltd",
            "createdAt": "2026-03-30T11:45:00Z"
        }
    ],
    "pagination": {
        "total": 1,
        "limit": 20,
        "offset": 0,
        "hasMore": false
    }
}

Modified at 2026-03-31 11:53:55

Create Customer

Get Customer