Skip to content
Documentation/API reference
API · profile

Retrieve profile

GET /api/v2/profile

Authorization

Authenticated user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example
inboxit profile get

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example
{
  "display_name": "Your Name",
  "avatar": null,
  "identity_provider": "supabase",
  "created_at": "2026-10-23T12:00:00Z",
  "is_admin": false
}

Behavior & errors

Returns the signed-in user profile. is_admin is platform administration, not the workspace role. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.