Sign in
Users

Search and list users

Overview

Retrieve a comprehensive list of all users within your customer's scope. This endpoint is ideal for auditing, synchronization, or building user-management dashboards.

Use Cases

  • Auditing: Regularly export user lists to verify access levels.
  • Synchronization: Keep an external user directory in sync with Prewave.
  • Management: Build custom internal dashboards for your organization.

Filtering

Refine your results using the following optional parameters:

  • Search: Matches against name or email (fuzzy matching).
  • Active: Filter by account status (active/deactivated).
  • Confirmed: Filter by whether the user has verified their account via email.

Pagination

This endpoint returns a paginated result. You can control the page size and offset using the page and size parameters.

  • Default Size: 100

  • Max Size: 1000

    Related Operations

    • Retrieve Detail: GET /public/v1/users/{userId}
    • Onboard User: POST /public/v1/users
    • Manage Roles: GET /public/v1/users/{userId}/roles
    • Update User: PATCH /public/v1/users/{userId}

Required Permission

access_public_users

get/public/v1/users

Query parameters

searchstring

Fuzzy search against first name, last name, or email.

activeboolean

Filter by account status. true for active users, false for deactivated ones.

confirmedboolean

Filter by confirmation status. true for users who have verified their email.

pageinteger

Zero-based page index (0..N)

sizeinteger

The size of the page to be returned

Response

Successfully retrieved the paginated list of users.

sizeinteger
numberinteger
totalElementsinteger
totalPagesinteger
numberOfElementsinteger
firstboolean
lastboolean
emptyboolean

Changes

No recorded changes to this endpoint across all 9 revisions of this API.