Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
User

Get the list of users.

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

get/api/v2/users

Query parameters

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30
Example:10

The number of result items in a single response.

emailstring
Example:john.doe@acmeinc.com

The exact value of the email address of a user. No wildcard matching or contains is applied.

rolestring[]

A single or comma separated value of user role.

statusstring[]

A single or comma separated value of user status.

Response

Success

UserIdinteger

The ID of the user.

FullNamestring

The name of the user.

Emailstring

Email of the user.

PhoneNumberstring nullable

Phone number of the user.

LastLoginDatestring date-time nullable

The date time that the user's last login to the Black Kite platform.

Creatorstring

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.

Example response

[
  {
    "UserId": 22,
    "FullName": "John Doe",
    "Email": "john.doe@acmeinc.com",
    "PhoneNumber": "806271728858254",
    "LastLoginDate": "2021-08-09T08:30:30.682Z",
    "Creator": "SYSTEM",
    "Status": "Active",
    "Role": "Super Admin",
    "AuthorizedEntities": [
      {
        "Id": 173,
        "Name": "MyCompanies"
      }
    ]
  }
]