Search users
Returns a list of users (referred to as Team Members on the Bytio dashboard) that match the supplied search parameters. Only Administrators (users in the admin
role) are able to access the users API endpoints.
Authorizations
Query Parameters
The search query string to use to search the User by their name or email.
100
Set to true
to return only enabled Users, false
to return only disabled Users. Omit to return all Users.
Limit the returned Users to those in the supplied role. Separate multiple values with a comma. Omit to return all Users.
admin
, collaborator
, billing_admin
The page of results to return.
1 < x < 1000
The number of Users to return per-page between 1 and 100. The default is 10.
1 < x < 100
Sort the returned Users returned by name
or role
.
name
, role
Determines the sort order of the returned Users. Valid values are ascending
or descending
. Defaults to descending
.
ascending
, descending
Response
ok