v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Users - company level

Get a list of users

Returns the list of users for the companyId identified in the path.

To make this request, your API credential must have the following role:

  • Management API—Users read and write
get/companies/{companyId}/users

Path parameters

companyIdstring required

The unique identifier of the company account.

Query parameters

pageNumberinteger

The number of the page to return.

pageSizeinteger

The number of items to have on a page. Maximum value is 100. The default is 10 items on a page.

usernamestring

The partial or complete username to select all users that match.

Response

OK - the request has succeeded.

itemsTotalinteger required

Total number of items.

pagesTotalinteger required

Total number of pages.