Users

Get a user

GET/api/users/{userId}

Returns details for the specified user account when the caller has permission to view it.

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>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
userIdrequired	string	ID of the associated user.

Responses

200The operation completed successfully.

Name	Type	Description
_countrequired	object

apiKeysrequired	object[]	API keys associated with the user.

boardsrequired	object[]	Boards associated with the user.

createdAtrequired	string	Date and time the record was created.
createdByrequired	object[]	ID of the user who created the resource.

idrequired	string	Unique identifier of the resource.
linksrequired	object[]	Tracked links associated with the user.

passwordrequired	string	Password used to authenticate the account.
pixelsrequired	object[]	Tracking pixels associated with the user.

reportsrequired	object[]	Saved reports associated with the user.

rolerequired	string	Permission role assigned to the user.
teamsrequired	object[]	Teams associated with the user.

twoFactorAuthrequired	object

twoFactorBackupCodesrequired	object[]

twoFactorOtpUsedsrequired	object[]

twoFactorRateLimitrequired	object

twoFactorRequiredrequired	boolean	Whether two-factor authentication is required.
usernamerequired	string	Username of the account.
websitesrequired	object[]

200 example

{
  "_count": {
    "apiKeys": 0,
    "boards": 0,
    "createdBy": 0,
    "links": 0,
    "pixels": 0,
    "reports": 0,
    "teams": 0,
    "twoFactorAuth": 0,
    "twoFactorBackupCodes": 0,
    "twoFactorOtpUseds": 0,
    "twoFactorRateLimit": 0,
    "websites": 0
  },
  "apiKeys": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "keyHash": "string",
      "keyPrefix": "string",
      "lastUsedAt": "2024-01-15T09:30:00Z",
      "name": "string",
      "userId": "string"
    }
  ],
  "boards": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "parameters": "string",
      "teamId": "string",
      "type": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "string"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "createdBy": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "createdBy": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "domain": "string",
      "id": "string",
      "name": "string",
      "recorderEnabled": true,
      "replayConfig": "string",
      "resetAt": "2024-01-15T09:30:00Z",
      "teamId": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "string"
    }
  ],
  "id": "string",
  "links": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "name": "string",
      "slug": "string",
      "teamId": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "url": "string",
      "userId": "string"
    }
  ],
  "password": "string",
  "pixels": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "name": "string",
      "slug": "string",
      "teamId": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "string"
    }
  ],
  "reports": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "description": "string",
      "id": "string",
      "name": "string",
      "parameters": "string",
      "type": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "string",
      "websiteId": "string"
    }
  ],
  "role": "string",
  "teams": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "role": "string",
      "teamId": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "string"
    }
  ],
  "twoFactorAuth": {
    "createdAt": "2024-01-15T09:30:00Z",
    "id": "string",
    "isEnabled": true,
    "secret": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "userId": "string"
  },
  "twoFactorBackupCodes": [
    {
      "codeHash": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "used": true,
      "userId": "string"
    }
  ],
  "twoFactorOtpUseds": [
    {
      "expiresAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "otp": "string",
      "userId": "string"
    }
  ],
  "twoFactorRateLimit": {
    "attempts": 0,
    "id": "string",
    "lockedUntil": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "userId": "string"
  },
  "twoFactorRequired": true,
  "username": "string",
  "websites": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "createdBy": "string",
      "deletedAt": "2024-01-15T09:30:00Z",
      "domain": "string",
      "id": "string",
      "name": "string",
      "recorderEnabled": true,
      "replayConfig": "string",
      "resetAt": "2024-01-15T09:30:00Z",
      "teamId": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "userId": "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/users/{userId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousDelete a user NextList a user's teams