---
title: "Get the list of users."
method: GET
path: "/api/v2/users"
tags: ["User"]
---

# Get the list of users.

`GET /api/v2/users`

Get the list of users listed on the Black Kite system.

## Query parameters

- `page_number` integer
- `page_size` 10 | 20 | 30
- `email` string
- `role` string[]
- `status` string[]

## Response `200`

Success

- User[]
  - `UserId` integer — The ID of the user.
  - `FullName` string — The name of the user.
  - `Email` string — Email of the user.
  - `PhoneNumber` string, nullable — Phone number of the user.
  - `LastLoginDate` string, date-time, nullable — The date time that the user's last login to the Black Kite platform.
  - `Creator` string — The information about the source where the user registered in the system. This value sometimes contains an email, sometimes only the source information.
  - `Status` 'Active' | 'Inactive' | 'Deleted' — The status information of the user.
  - `Role` 'Super Admin' | 'Super User' | 'Ecosystem Admin' | 'Ecosystem User' | 'Company Admin' | 'Company User' — The role information of the user.
  - `AuthorizedEntities` UserAuthorizedEntity[], nullable — An array of authorized entities. This array might include ecosystem information for ecosystem admins and ecosystem users, company information for company admins and company users. It might be null for super admins.
    - `Id` integer — The unique ID of the authorized entity. The value is an ecosystem ID for an ecosystem admin and ecosystem user, whereas on the other hand, the value is company ID for a company admin and company user.
    - `Name` string — The name of the authorized entity. The value is an ecosystem name for an ecosystem admin and ecosystem user, whereas on the other hand, the value is company name for a company admin and company user.

## Other responses

- `401` — Unauthorized
- `default` — Failure

---

[API](https://skmtc.net/blackkitetech/apis/black-kite-api.md) · [All operations](https://skmtc.net/blackkitetech/apis/black-kite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blackkitetech/black-kite-api/revisions/7dadaba760fb/schema)