Skip to main content
GET
List Banned Members

Authorizations

Authorization
string
header
required

Send platform JWTs, contact JWTs, or team API keys as Authorization: Bearer <token>.

Path Parameters

team_id
string
required
hub_id
string
required

Query Parameters

sort
enum<string>
default:-banned_at

Sort order for the banned list. One of: -ban_note, -ban_reason, -banned_at, -banned_by_name, -member_name, ban_note, ban_reason, banned_at, banned_by_name, member_name

Available options:
-ban_note,
-ban_reason,
-banned_at,
-banned_by_name,
-member_name,
ban_note,
ban_reason,
banned_at,
banned_by_name,
member_name
page[size]
integer
default:50
Required range: 1 <= x <= 100
page[after]
string | null

Response

Successful Response

data
BannedMemberResource · object[]
required
included
ContactIncludedResource · object[] | null
meta
Meta · object | null