Get account

Get account information

GET /api/v1/user/account

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "user": {
      "id": "<string>",
      "type": "registered",
      "isActive": true,
      "email": "<string>"
    },
    "authentication": {
      "type": "session"
    },
    "organization": {
      "name": "<string>",
      "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z"
    },
    "embedWriteContext": {
      "canUseAiAgent": true,
      "canCreateSavedChart": true,
      "canUpdateSavedChart": true,
      "canUpdateDashboard": true,
      "aiAgentErrorMessage": "<string>"
    }
  },
  "status": "ok"
}

Response

200

application/json

Success

results · object · required

The account as returned by the API. Kept to what the app needs so a session never echoes its own credential (cookie, token, key) or, for embeds, the embed configuration behind the JWT.

We omit AbilityRules because tsoa is very unforgiving. We'll still get this in the UI to apply abilities. The same approach is taken for SessionUser from the UserController.

Show child attributes

status · enum<string> · required

Available options: ok