List members of a specific club

get

https://api.staging.antavo.com/v1/clubs/{club_id}/members

This endpoint returns the registered club members of a specified club. You can filter members by various parameters, such as member ID, role, and status. Pagination is also supported through offset and limit query parameters.

Path Params

club_id

string

required

The unique identifier of the club whose members are being requested.

Query Params

id.eq

string

Filter to a specific club member by their unique identifier.

role

string

enum

Filter by member type. Possible values are 'owner' or 'member'.

Allowed:

status

string

enum

Filter by member status. Possible values are 'applicant', 'active', 'kicked', 'removed', or 'banned'.

Allowed:

offset

integer

Defaults to 0

Offsets the starting number of club members to return. This is used in pagination in conjunction with the limit query.

limit

integer

1 to 100

Defaults to 20

Limits the number of members returned in one response. Other values are accessible by pagination made accessible via the offset.

Responses

Language

Credentials

Query

Loading…

Response

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

application/json

200Successful response with the list of club members.

400Bad request due to invalid parameters.