Get all users

Retrieves a list of all users. Requires admin or project owner privileges.

get/users

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/users
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Response

Users retrieved successfully

Example response

{
  "items": [
    {
      "id": "1357158568008091264",
      "email": "john.doe@example.com",
      "role": "admin",
      "name": "John Doe",
      "username": "john_doe",
      "avatar": {
        "url": "https://storage.example.com/user-avatars/1357158568008091264/original.jpg",
        "thumbnailUrls": {
          "cover180": "https://storage.example.com/user-avatars/1357158568008091264/cover-180.jpg"
        }
      },
      "gravatarUrl": "https://www.gravatar.com/avatar/abc123",
      "phone": "+1234567890",
      "organization": "Acme Corporation",
      "language": "en-US",
      "apiKeyPrefix": "D89VszVs",
      "subscribeToCardWhenCommenting": true,
      "enableFavoritesByDefault": true,
      "defaultEditorMode": "wysiwyg",
      "defaultHomeView": "groupedProjects",
      "defaultProjectsOrder": "byDefault",
      "lockedFieldNames": [
        "email",
        "password",
        "name"
      ],
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.