List approval groups

get

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

One page of this tenant's groups, without their members. Requires
group:manage, and the path tenant must equal the caller's
tenant_id claim.

Deactivated groups are included unless status (case-sensitive)
narrows them out. name is a case-insensitive substring match.
Ordering defaults to name,asc.

Path Params

uuid

required

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

Query Params

name

string

Substring to match against the group name.

status

string

enum

Keep only groups in this status. Case-sensitive.

Allowed:

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: key, name, status, createdAt,
updatedAt, id. Defaults to name,asc. 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 groups.

400id is not a UUID, or status is not a known constant.

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

403No group:manage permission, or the path tenant is not the caller's own.

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