Kitchen API reference

Clients

List Clients

GET /v1/clients

curl 'https://{workspace}.kitchen.co/api/v1/clients' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Response

{
  "data": [
    {
      "id": "1",
      "added_on": "2021-10-26T12:02:44+00:00",
      "name": "John Doe",
      "email": "[email protected]",
      "username": "johndoe",
      "phone": "012345678",
      "timezone": null,
      "group": "client",
      "role": "member",
      "avatar_type": null,
      "avatar_url": null,
      "avatar_gravatar_url": null,
      "avatar_file": null,
      "color": "#32abfe",
      "default_color": "#32abfe",
      "is_active": true,
      "last_seen": null,
    },
    …
  ],
  "meta": {
    …
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27



Retrieve a Client

GET /v1/clients/{client_id}

curl 'https://{workspace}.kitchen.co/api/v1/clients/{client_id}' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

client_id string required

The id of the Client.

Response

{
  "id": "1",
  "added_on": "2021-10-26T12:02:44+00:00",
  "name": "John Doe",
  "email": "[email protected]",
  "username": "johndoe",
  "phone": "012345678",
  "timezone": null,
  "group": "client",
  "role": "member",
  "avatar_type": null,
  "avatar_url": null,
  "avatar_gravatar_url": null,
  "avatar_file": null,
  "color": "#32abfe",
  "default_color": "#32abfe",
  "is_active": true,
  "last_seen": null,
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19



Create a Client

POST /v1/clients

curl 'https://{workspace}.kitchen.co/api/v1/clients' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}' \
 -d 'name=Jane Doe' \
 -d '[email protected]' \
 -X POST
1
2
3
4
5
6

Body parameters

name string required

The name of the Client.

email string required

The email of the Client.

password string optional

The password. If left blank the client will be able to login with a magic code.

notification bool optional

Whether a welcome notification should be send. Default 0.

Response

{
  "id": "2",
  "added_on": "2021-10-26T12:02:44+00:00",
  "name": "Jane Doe",
  "email": "[email protected]",
  "username": "johndoe",
  "phone": "012345678",
  "timezone": null,
  "group": "client",
  "role": "member",
  "avatar_type": null,
  "avatar_url": null,
  "avatar_gravatar_url": null,
  "avatar_file": null,
  "color": "#32abfe",
  "default_color": "#32abfe",
  "is_active": true,
  "last_seen": null,
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19



List Clients from a Project

GET /v1/projects/{project_id}/clients

curl 'https://{workspace}.kitchen.co/api/v1/projects/{project_id}/clients' \
 -H 'Accept: application/json' \
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

project_id string Required

The id of the Project.

Response

{
  "data": [
    {
      "id": "1",
      "added_on": "2021-10-26T12:02:44+00:00",
      "name": "John Doe",
      "email": "[email protected]",
      "username": "johndoe",
      "phone": "012345678",
      "timezone": null,
      "group": "client",
      "role": "member",
      "avatar_type": null,
      "avatar_url": null,
      "avatar_gravatar_url": null,
      "avatar_file": null,
      "color": "#32abfe",
      "default_color": "#32abfe",
      "is_active": true,
      "last_seen": null,
    },
    …
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24