Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Inbox

List inbox categories

<small>Requires the inbox:read scope (or a broader one that includes it).</small>

Returns all inbox categories visible to the current user, including reserved system categories.

get/v3/inbox/threads/categories

Query parameters

ownerUserIdinteger

Restrict to categories visible to the given user. The target must be a member of the caller's team; otherwise the request fails with 400 inboxCategory.invalidInput.

Response

Inbox categories

idinteger required
namestring required
color'gray' | 'green' | 'blue' | 'red' | 'yellow' | 'purple' | 'orange' | 'lightBlue' | 'olive' required
isReservedboolean required

True for system-reserved categories (e.g., the default category). Reserved categories cannot be renamed, recoloured, or deleted.

unreadThreadsCountinteger required

Number of unread threads currently assigned to this category.