Skip to main content

Workspace

uuidstring<uuid>required
namestringrequired
hex_colorstringdeprecated

Deprecated. Workspaces no longer have a colour (workspaces now use avatar); the API returns the constant 4f46e5 so existing clients keep working. Will be removed in API v2.

Example: 4f46e5
avatar(string | null)<uri>nullable

URL of the workspace avatar, or null when none is set. Supersedes hex_color.

owner object
idintegerrequired
namestringrequired
emailstring<email>required
avatar(string | null)<uri>nullable

URL of the user's avatar, or null when none is set.

is_adminbooleanrequired
email_verified_atstring | nullnullable

Display string in the configured timezone and clock: M j, H:i this year, M j, Y, H:i otherwise (12-hour setting: h:ia), not RFC 3339.

Example: Oct 16, 14:05
created_atstringrequired

Display string in the configured timezone and clock: M j, H:i this year, M j, Y, H:i otherwise (12-hour setting: h:ia), not RFC 3339.

Example: Mar 3, 2025, 09:12
access_statusstringrequired

Possible values: [subscription, unlimited, locked]

created_atstringrequired

Display string in the configured timezone and clock: M j, H:i this year, M j, Y, H:i otherwise (12-hour setting: h:ia), not RFC 3339.

Example: Oct 16, 14:05
Workspace
{
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"avatar": "string",
"owner": {
"id": 0,
"name": "string",
"email": "[email protected]",
"avatar": "string",
"is_admin": true,
"email_verified_at": "Oct 16, 14:05",
"created_at": "Mar 3, 2025, 09:12"
},
"access_status": "subscription",
"created_at": "Oct 16, 14:05"
}