API Reference
Privacy policy

List clubs

get
https://api.staging.antavo.com/v1/clubs

This endpoint returns the list of clubs based on various query parameters.

Query Params
string

Filter to a specific club by ID.

string

Filter by associated template ID.

string

Filter by name.

string
enum

Filter by template type.

Allowed:
string
enum

Filter by status.

Allowed:
integer
Defaults to 0

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

integer
1 to 100
Defaults to 20

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

Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?