Sign in

v1

latestSwagger 2.02026-07-17172265595.1 KB
users

List Users

Retrieves a list of users who are members of the workspace.

get/auth/api/v1/users

Request body

emailstring
emailVerifiedboolean

Filter by

roleName'admin' | 'editor' | 'viewer'

Example request

{
  "email": "johndoe@example.com",
  "emailVerified": true
}

Response

OK

connector_idstring
created_atstring

Creation timestamp in UTC

emailstring

Email address of the user

email_verifiedboolean

Is email verified or not

external_idstring
full_namestring
idinteger

Unique identifier for the user

is_activeboolean
last_activitystring

Last activity timestamp in UTC

role_name'admin' | 'editor' | 'viewer'
usernamestring

Username

Example response

[
  {
    "created_at": "2023-03-31T09:36:09.855Z",
    "email": "johndoe@example.com",
    "email_verified": true,
    "id": 1,
    "last_activity": "2023-04-21T08:53:09.928Z",
    "username": "John Doe"
  }
]