---
title: "Returns a list of all users including admins"
method: GET
path: "/users"
tags: ["Users"]
---

# Returns a list of all users including admins

`GET /users`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/users`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

## Retrieve Users
Endpoint for retrieving a collection of Users (this includes admins).

## Query parameters

- `relationships` string
- `includes` string
- `page[size]` integer
- `page[number]` integer

## Response `200`

success

- UserCollectionResponse
  - `data` User[]
    - `id` string
    - `type` string
    - `attributes` UserAttributes
      - `name` string
      - `username` string
      - `email` string
      - `active` boolean
      - `last_login` union
        - string, date-time
        - 'Never'
      - `status` 'created' | 'invited' | 'verified': Invitation status of the user. `created` is the default state for a freshly created user. `invited` means the user has a non-expired invite/welcome email token. `verified` means the user has logged in at least once.
      - `is_client_admin` boolean
      - `is_delegated_admin` boolean
      - `is_adfs_user` boolean
      - `is_sso_user` boolean
      - `signature` string, nullable
      - `company` string
      - `expires` union: Wall clock in the client timezone, or `NEVER`
        - string
        - 'NEVER'
      - `type` 'normal' | 'shared' | 'admin' | 'direct-link'
      - `user_type` string: Deprecated: use `type` instead. Removal scheduled 2027-01-13.
      - `can_create_lightbox` boolean
      - `can_edit_profile` boolean
      - `can_post_comments` boolean
      - `can_folder_share` boolean
      - `can_internal_folder_share` boolean
      - `can_share_folders_and_files` boolean
      - `can_internal_folder_and_file_share` boolean
      - `can_direct_login` boolean
      - `show_brand_section` boolean
      - `hide_menu_by_default` boolean
      - `is_direct_link_user` boolean
      - `can_request_api` boolean
      - `notify_active` boolean
      - `notify_frequency` 0 | 1 | 2 | 3: How often notification emails are sent, in enum order: immediately, daily, weekly, monthly
      - `is_allowed_url_copy_with_direct_access` boolean
      - `custom_metadata` string
      - `internal_metadata` string
  - `links` UserPaginationLinks
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` UserPaginationMeta
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` object[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer
    - `filter` union: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string, nullable

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/kontainer/apis/kontainer-api-documentation.md) - [All operations](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kontainer/apis/kontainer-api-documentation/revisions/b80a5167e09a?raw)