Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

User Endpoints

Look Up User by Username

Resolves a username to a user’s profile information.

GET /api/v1/users/{username}

Authentication: Required.

Path Parameters

ParameterTypeDescription
usernamestringThe username to look up.

Request Body

None.

Response Body — UserInfoResponse

FieldTypeDescription
user_idint64The user’s unique ID.
usernamestringThe user’s username.
aliasstringThe user’s display name (may be empty).
signing_key_fingerprintstringSHA-256 hex of the user’s MLS signing public key (may be empty).

Status Codes

CodeCondition
200 OKUser found.
401 UnauthorizedInvalid or expired token.
404 Not FoundNo user with that username exists.

SSE Events

None.


Look Up User by ID

Resolves a user ID to a user’s profile information.

GET /api/v1/users/by-id/{user_id}

Authentication: Required.

Path Parameters

ParameterTypeDescription
user_idint64The user ID to look up.

Request Body

None.

Response Body — UserInfoResponse

FieldTypeDescription
user_idint64The user’s unique ID.
usernamestringThe user’s username.
aliasstringThe user’s display name (may be empty).
signing_key_fingerprintstringSHA-256 hex of the user’s MLS signing public key (may be empty).

Status Codes

CodeCondition
200 OKUser found.
401 UnauthorizedInvalid or expired token.
404 Not FoundNo user with that ID exists.

SSE Events

None.