Skip to content

List superadmin accounts and their active/inactive status (superadmin)

GET
/v1/users/superadmins
curl --request GET \
--url https://example.com/v1/users/superadmins \
--header 'Authorization: Bearer <token>'

Lists the superadmin accounts with the active or inactive status of each.

OK

Media type application/json
object
cursor
string
has_more
required
boolean
items
required
Array<object>
object
created_at
required
string format: date-time
display_name
string
email
required
string format: email
id
required
string format: uuid
is_superadmin
required
boolean
status
required
string
Allowed values: active inactive
Example
{
"items": [
{
"status": "active"
}
]
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}