Account

Get my authentication details

GET/api/me

Returns the current authentication context, including the authenticated user or share credentials.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

Responses

200The operation completed successfully.

Name	Type	Description
apiKey	object	API key authentication details.

authType	anyOf

shareToken	object

user	object	User associated with the resource.

200 example

{
  "apiKey": {
    "id": "string",
    "name": "string"
  },
  "authType": {},
  "shareToken": {
    "boardId": "string",
    "linkId": "string",
    "linkIds": [
      "string"
    ],
    "parameters": {
      "allowFilter": true,
      "theme": {}
    },
    "pixelId": "string",
    "pixelIds": [
      "string"
    ],
    "shareType": 0,
    "websiteId": "string",
    "websiteIds": [
      "string"
    ]
  },
  "user": {
    "id": "string",
    "isAdmin": true,
    "role": "string",
    "username": "string"
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/me' \
  -H 'Authorization: Bearer <token>'

PreviousDelete an API key NextList my API keys