List all clients
Returns a list of your clients. The clients are returned sorted by creation date, with the most recently created clients appearing first.
Parameters
No parameters.
Returns
Return a paginated response that contains an array of up to the specified limit of clients.
get
/api/clients
curl https://{workspace}.kitchen.co/api/clients \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Requested-With: XMLHttpRequest' \
-H 'Authorization: Bearer {API_KEY}'
Response
{
"data": [
{
"created_at": "2024-05-22T11:20:13+00:00",
"email": "edurgan@example.com",
"group": "client",
"id": "u_8425341c47ac43f6b69b5d85",
"language": null,
"name": "Dr. Carol Rice IV",
"phone": null,
"role": "member",
"timezone": null,
"title": null,
"updated_at": "2024-05-22T11:20:13+00:00",
"username": "bfahey"
}
],
"links": {
"first": "https://{workspace}.kitchen.co/api/clients?page=1",
"last": "https://{workspace}.kitchen.co/api/clients?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://{workspace}.kitchen.co/api/clients?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://{workspace}.kitchen.co/api/clients",
"per_page": 20,
"to": 1,
"total": 1
}
}