---
title: "GET /api/user"
method: GET
path: "/api/user"
tags: ["/api/user"]
---

# GET /api/user

`GET /api/user`

Fetch a list of `Users` for admins or group managers.
  By default returns only active users for admins/data-analysts and only active users within groups that the group manager is
  managing for group managers.

   - If `status` is `deactivated`, include deactivated users only.

   - If `status` is `all`, include all users (active and inactive).

   - Also supports `include_deactivated`, which if true, is equivalent to `status=all`; If is false, is equivalent to
     `status=active`. `status` and `include_deactivated` requires superuser permissions.

   - `include_deactivated` is a legacy alias for `status` and will be removed in a future release, users are advised
     to use `status` for better support and flexibility.

   If both params are passed, `status` takes precedence.
  - if a `tenant_id` is passed, only users with that tenant_id will be returned.

  For users with segmented permissions, return only themselves.

  Takes `limit`, `offset` for pagination.

  Takes `query` for filtering on first name, last name, email.

  Also takes `group_id`, which filters on group id.

  If the user is a sandboxed user, only return themselves regardless of the query parameters.

## Query parameters

- `status` string, nullable
- `query` string, nullable
- `group_id` integer, nullable — value must be an integer greater than zero.
- `include_deactivated` boolean, nullable, required
- `is_data_analyst` boolean, nullable
- `can_access_data_studio` boolean, nullable
- `tenancy` 'all' | 'internal' | 'external', nullable
- `tenant_id` integer, nullable — value must be an integer greater than zero.

## Response `2XX`

Successful response

## Other responses

- `4XX` — Client error response
- `5XX` — Server error response

---

[API](https://skmtc.net/metabase/apis/metabase-api.md) · [All operations](https://skmtc.net/metabase/apis/metabase-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metabase/metabase-api/versions/08b5a2bafb4f/schema)