List team members

get

https://api.qfp.quantnetwork.net/api/tenants/{id}/users

One page of the caller's own team. The path tenant must equal the
caller's tenant_id claim; a mismatch is 403. No permission is
required.

Filters combine, and each is ignored when absent:

search: case-insensitive substring match against name and email
(%, _ and \ match literally).
status: exact, case-sensitive match on one UserStatus.
role: role name, case-insensitive after trimming.

REMOVED members are included unless filtered out; removal is a soft
delete.

Path Params

uuid

required

The tenant. Must equal the caller's tenant_id claim; a mismatch is
403 Invalid tenant id.

Query Params

string

Substring to match against name and email.

status

string

enum

ACTIVE is the only status that grants platform access. INVITED is
set at creation and holds until the user sets their own password.
REMOVED is set by a removal, which is a soft delete. DEACTIVATED
is not set by any endpoint in this service.

Allowed:

role

string

page

integer

≥ 0

Defaults to 0

Zero-based page index.

size

integer

≥ 1

Defaults to 20

sort

array of strings

Sort order, as property or property,(asc|desc), repeatable.
Sortable properties: firstName, lastName, email, status,
createdAt, updatedAt, id, and paths such as role.name. An
unknown property surfaces as a 500.

sort

Headers

API-Version

string

required

^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200One page of members.

400status is not a UserStatus, or id is not a UUID.

401No bearer token, or a token that failed verification. Always Authentication token is missing or invalid.; the reason is never disclosed.

403The path tenant is not the caller's own (Invalid tenant id).

500sort named a property that does not exist on the user entity.