Skip to main content
GET
/
manage
/
users
List All Users
curl --request GET \
  --url https://cloud.onyx.app/api/manage/users \
  --header 'Authorization: Bearer <token>'
{
  "accepted": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "role": "limited",
      "is_active": true,
      "password_configured": true
    }
  ],
  "invited": [
    {
      "email": "<string>"
    }
  ],
  "slack_users": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "role": "limited",
      "is_active": true,
      "password_configured": true
    }
  ],
  "accepted_pages": 123,
  "invited_pages": 123,
  "slack_users_pages": 123
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Query Parameters

q
string | null
accepted_page
integer | null
slack_users_page
integer | null
invited_page
integer | null
include_api_keys
boolean
default:false

Response

Successful Response

accepted
FullUserSnapshot · object[]
required
invited
InvitedUserSnapshot · object[]
required
slack_users
FullUserSnapshot · object[]
required
accepted_pages
integer
required
invited_pages
integer
required
slack_users_pages
integer
required