GetUsers | Voximplant Voice AI

Shows the users of the specified account.

Allowed roles: Owner, Admin, Developer, Supervisor, User manager.

Example request: Get two first identities.

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.

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](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

application_idintegerRequired

The application ID to filter

application_namestringRequired

The application name part to filter

skill_idintegerOptional

The skill ID to filter

excluded_skill_idintegerOptional

The excluded skill ID to filter

acd_queue_idintegerOptional

The ACD queue ID to filter

excluded_acd_queue_idintegerOptional

The excluded ACD queue ID to filter

user_idintegerOptional

The user ID to filter

user_namestringOptional

The user name part to filter

user_activebooleanOptional

Whether the user is active to filter. Inactive users cannot log in to applications

user_display_namestringOptional

The user display name part to filter

with_skillsbooleanOptionalDefaults to false

Whether to get the bound skills

with_queuesbooleanOptionalDefaults to false

Whether to get the bound queues

acd_statuslist of stringsOptional

The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND

showing_skill_idintegerOptional

The skill to show in the 'skills' field output

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

order_bystringOptionalDefaults to user_name

The following values are available: ‘user_id’, ‘user_name’ and ‘user_display_name’

return_live_balancebooleanOptionalDefaults to true

Whether to get the user live balance

Response

Successful response

resultlist of objects

The UserInfoType records

total_countinteger

The total found user count

countinteger

The returned user count

$	curl -X POST "https://api.voximplant.com/platform_api/GetUsers?application_id=12345&application_name=CustomerSupportApp&count=2&offset=0&order_by=user_name" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"result": [
3	{
4	"user_id": 101,
5	"user_name": "jdoe",
6	"user_display_name": "John Doe",
7	"user_active": true,
8	"balance": 15.75,
9	"modified": "2024-04-20 09:15:42",
10	"frozen": false
11	},
12	{
13	"user_id": 102,
14	"user_name": "asmith",
15	"user_display_name": "Alice Smith",
16	"user_active": true,
17	"balance": 8.5,
18	"modified": "2024-04-19 16:47:10",
19	"frozen": false
20	}
21	],
22	"total_count": 2,
23	"count": 2
24	}