RillaRilladevelopers
Go to Rilla
DocumentationData Export APIFull reference

List users

List users without metrics, to find a userId.

GET/export/users
Authentication
Authorization: YOUR_API_KEY

No Bearer prefix.

Base URL: https://customer.rillavoice.com

Parameters

querystring · query

Part of a full name or email, case-insensitive, up to 200 characters.

teamIdstring · uuid · query

Only this team’s direct members.

rolestring · query

Part of a role name, case-insensitive, up to 100 characters, such as Sales Rep, Team Manager or Admin, plus any role your organization added. Groups such as regions or offices are teams, not roles.

removedboolean · query

true for removed users only, false for active users only. Omit for both.

pageinteger · query

Page to return, from 1. Needs limit; without it, every user your key can access comes back on one page.

limitinteger · query

Users per page, up to 10,000. Omit it to get every user your key can access at once.

Sorted by name. Results remain restricted to the users your API key can access.

Responses

200Returns UserListResponse
usersUserListEntry[]

Users on this page, sorted by name.

currentPagenumber

The page returned.

totalPagesnumber

Pages available; request the next page to get more.

totalUsersnumber

Users across all pages.

401Missing or invalid API key.
400Invalid request parameters.
Error reference

Common problems

400 · "Request body failed validation"

The message is the same for invalid query and path parameters. Read errors[].path and errors[].message. Send every parameter in the query string, URL-encoded; these GET requests take no body. page needs limit; each is a positive integer up to 10,000.

401 · Missing or invalid key

Use Authorization: YOUR_API_KEY, without Bearer, and the customer.rillavoice.com host. Use the key value, not its ID.

200 · Empty or missing rows

Results are limited to what your API key can access; an unknown teamId or one outside that scope gives an empty page. Keep requesting the next page until currentPage reaches totalPages.

← Export usersExport teams