API Reference

Bulk Export Users

post
https://core.{customerId}.ec.avayacloud.com/api/config/v1/users:bulk-export

Required Role: Admin Portal or Admin API Consumer

Bulk exports the list of users for an account based on the criteria provided.

If the optional folderId query parameter is provided, users within that folder and all of its subfolders
(recursively) will be exported.

Will trigger an asynchronous job, the status of which should be monitored via /jobs/{jobId}.

Once the job has completed, the file can be downloaded using the API /jobs/{jobId}/exported-users.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 1 and 255

Optional name that can be provided to identify the job.

string
^073[0-9a-f]{23}$

(Optional) Export users from a specific folder and all its subfolders.
Provide the unique 26-character internal id of the folder.
If omitted, all users in the account will be included.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago

Did this page help you?