GET
/
customers
List customers
curl --request GET \
  --url https://app.kapso.ai/api/v1/customers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "customer-123abc",
      "name": "Acme Corporation",
      "external_customer_id": "CUS-12345",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
q[name_cont]
string

Filter by name containing text

​
q[external_customer_id_eq]
string

Filter by exact external customer ID

​
q[created_at_gteq]
string<date-time>

Filter by creation date (greater than or equal)

​
q[created_at_lteq]
string<date-time>

Filter by creation date (less than or equal)

Response

200
application/json

A list of customers

The response is of type object.