Get a list of users

get /companies/{companyId}/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

Endpoint destination URL{companyId}/users
Click to copy

Query parameters

username string

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

pageSize integer

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

pageNumber integer

The number of the page to return.

Path parameters

companyId string Required

The unique identifier of the company account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less