Skip to main content
GET
White Label Admin - Get all white label users

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

Query Parameters

active
integer

Whether to search for entities (users, orgs) active in the last X days

tier
enum<string>

Whether to search for free, community plus, professional, or enterprise entities (users, projects) The user account tier.

Available options:
free,
community-plus,
professional,
enterprise
fields
string

Comma separated list of fields to fetch in a query

Example:

"id,name"

sort
string

Fields and order to sort query by Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example:

"id,-name"

filters
string

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example:

"billable:true"

limit
integer

Maximum number of results

offset
integer

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Search query

Example:

"<id> <name>"

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

total
integer
required
users
object[]
required
error
string

Optional error description (set if 'success' was false)