Skip to main content
GET
/
customers
List customers
curl --request GET \
  --url https://app.kapso.ai/api/v1/customers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corporation",
      "external_customer_id": "CUS-12345",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Authorizations

​
X-API-Key
string
header
required

Your project API key

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 string

​
q[external_customer_id_eq]
string

Filter by exact external customer ID

Response

List of customers

​
data
object[]
​
meta
object