List Users Across Several Teams

get

https://api.revenium.ai/profitstream/v2/api/users

Retrieve a paginated list of users drawn from every team named in teamIds, optionally narrowed by an email substring. Answers in one request what the single-team listing answers in one request per team; the caller must be able to view every team it names.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

Case-insensitive substring matched against the user's email address. Applied by the database so matches outside the requested page are still found.

teamId

string

required

Unique identifier of the team (organization) to filter results. Format: Revenium hashid (URL-safe encoded string).

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

size

integer

≥ 1

Defaults to 10

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

teamIds

array of strings

required

Comma-separated identifiers of the teams (organizations) to draw users from. Format: Revenium hashid (URL-safe encoded string).

teamIds*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Returns a paginated list of User objects. Ordered by email address unless the caller supplies sort; either way a unique tie-breaker is appended, so paging never skips or repeats a user.

400Bad request - Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions for one of the requested teams

404Not found - One of the requested teams does not exist

409Conflict

422Unprocessable entity - Validation failed

429Too Many Requests