Skip to main content
GET
List hub member directory

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

hub_id
string
required

Query Parameters

filter[search]
string | null
filter[online]
enum<string>

Filter to online members only. Only 'true' is accepted; any other value returns 422.

Available options:
true
filter[role]
string | null

Comma-separated role filter. Accepted tokens: owner, admin, moderator, member. 'member' matches rows with role IS NULL (regular members). Multiple tokens are OR-combined; unknown token or empty set → 422.

sort
enum<string>

Sort order for the member list. Omit for default id-ASC order.

Available options:
created_at,
-created_at,
last_seen_at,
-last_seen_at,
name,
-name
page[size]
integer
default:20
Required range: 1 <= x <= 100
page[after]
string | null

Response

Successful Response

members list response with typed meta (overrides the generic dict meta).

data
JsonApiResource[MemberDirectoryAttributes] · object[]
required
included
any[] | null
meta
MemberDirectoryListMeta · object | null