Kitchen API reference

Users

The User object

{
    "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

Attributes

id string

Unique identifier of the User.

added_on datetime

The creation datetime.

name string

The full name of the User.

email string

The email of the User.

username string

The username of the User.

phone string|null

The phone number of the User.

group string

The type of the User. Can be manager or client.

role string

The role of the User. Client users have only one role member. Managers can have three differen roles owner, admin and member.

avatar_type string

The type of the User's avatar. Can be file or gravatar.

avatar_url string|null

The url of the User's avatar.

avatar_gravatar_url string

The gravatar url of the User.

avatar_file File|null

The File of the User's avatar. See The File object

color string

The color of the User.

default_color string

The default color of the User, calculated using User's email.

is_active bool

Whether the User's account is active. Applicable only to manager Users.

last_seen datetime

The last time the User have been seen in the Workspace.