Unread client messages across the team, for the bell

GET

/api/inbox/unread/

curl --request GET \
  --url http://localhost:8000/api/inbox/unread/ \
  --header 'Authorization: Bearer <token>'

• Local development
• Production

Muted conversations are left out.

A coach of the active team. 404 while client access is switched off; a partner API key and a client’s own account get 403; 429 past the account’s rate (chat_read, 240/min).

Authorizations

• ApiKeyBearer
• localJwtAuth
• FirebaseBearer
• FirebaseSessionCookie

Responses

200

Media typeapplication/json

GET /api/inbox/unread/.

object

count

required

Unread client-side messages; muted conversations left out.

integer

Examples

ExampleUnread

{
  "count": 3
}

401

Media typeapplication/json

object

detail

required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example ^generated

{
  "detail": "example"
}

403

Media typeapplication/json

object

detail

required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Examples

Example403—AClient'sOwnAccount

403 — a client's own account

{
  "detail": "client_account"
}

404

Media typeapplication/json

object

detail

required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example ^generated

{
  "detail": "example"
}

429

Media typeapplication/json

object

detail

required

429 — throttled: this account’s (or address’s) rate for the route is used up; try again after wait seconds, which Retry-After repeats. A route with a limit of its own answers its own code instead, documented there.

string

wait

With throttled: whole seconds until the next request can pass.

integer

nullable

Example ^generated

{
  "detail": "example",
  "wait": 1
}