Skip to navigation
Management APIReferenceAdmin Users

GetAdminUsers

View as Markdown

Gets the admin users of the specified account. Note that both account types - parent and child - can have its own admins.

Example request: Get two first admin users.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

required_admin_user_idintegerOptional
The admin user ID to filter
required_admin_user_namestringOptional
The admin user name part to filter
admin_user_display_namestringOptional
The admin user display name part to filter
admin_user_activebooleanOptional
Whether the admin user is active to filter
with_rolesbooleanOptionalDefaults to false
Whether to get the attached admin roles
with_access_entriesbooleanOptionalDefaults to false
Whether to get the admin user permissions
countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response
resultlist of objectsOptional
total_countintegerOptional
The total found admin user count
countintegerOptional
The returned admin user count