Skip to main content
GET
/
customers
/
List customers
curl --request GET \
  --url https://api.kelviq.com/api/v1/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "customerId": "unique-customer-id-123",
      "name": "John Doe",
      "email": "new.customer@example.com",
      "details": {},
      "metadata": {
        "source": "sdk_import",
        "priority": "high"
      },
      "billingAddress": {
        "country": "IN",
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "postalCode": "560001",
        "city": "Bangalore",
        "state": "Karnataka"
      },
      "createdOn": "2025-06-04T06:03:30.195790Z",
      "modifiedOn": "2025-06-04T06:03:30.195831Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Query Parameters

Free-text search across the customer's name, email and customerId.

page_size
integer

Number of results to return per page. Defaults to 1000, maximum 10000.

page
integer

The page number of results to return.

Response

200 - application/json

A paginated list of customers.

count
integer
next
string<uri> | null
previous
string<uri> | null
results
object[]