Up - API Reference - Home
A user is anyone who can login to the system, either a person using name and password or a program using an API key.
User data comes in two forms, a complete version for the current user, and a short version for other members of the project.
The returned dictionary uses the global identifier (gid) as a key.
{
…,
"data": {
"cc.users": {
"b76f701d-3d34-4f39-8eeb-fafe294ab01e": {
"gid": "b76f701d-3d34-4f39-8eeb-fafe294ab01e",
"username": "member-name",
"name": "Member Name",
"avatar": "f2e64fe0-9ffa-4d9a-8750-d561d6542453.png",
"status": "active"
}
}
}
}
{
…,
"data": {
"cc.users": {
"d05ba499-df89-4de3-9d83-c68b64c3856b": {
"gid": "d05ba499-df89-4de3-9d83-c68b64c3856b",
"username": "user-name",
"email": "name@website.com",
"name": "User Name",
"avatar": "1ad71cbd-9b97-4ea7-94ef-bcdd86c6467c.jpg",
"status": "active",
"options": {
"language": "en",
"timezone": "Europe/Amsterdam"
}
}
}
}
}
gid¹ global identifier
username¹ login name, null for API key users
email email address for e.g. notifications
name¹ user's name
avatar¹ link to an uploaded asset used to represent the user (optional; if empty, initials are used)
status only active users can authenticate to obtain a JWT
options a collection of additional values, described below
¹ These are public properties
language the language to use in the user interface, unrelated to project languages - currently, only en is supported
timezone the timezone used to enter and display date/time values for the user - backend storage is always in UTC