API docs by Redocly

Federation API (2.1.1)

Download OpenAPI specification:

API for retrieving club, accommodation and membership data.

Clubs

Club-related operations

Retrieve club data

Retrieve clubs with their basic data and related accommodations.

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "Verenigingsgegevens": [
    ]
}

Accommodations

Accommodation-related operations

Retrieve accommodation data

Retrieve accommodations with address and location data.

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "Accommodatiegegevens": [
    ]
}

Memberships

Membership-related operations

Retrieve membership data

Retrieve memberships filtered by mutation date.

query Parameters
peildatum
string <date> ^\d{4}-\d{2}-\d{2}$

Optional date in format yyyy-mm-dd. Only memberships that were created or updated between this date and the time of the request are returned, even if the change concerns attributes not exposed by this API. Memberships without any mutation in this period are excluded.

limit
integer >= 1

Optional. Maximum number of records to return. Used only if paging is applied/enforced.

offset
integer >= 0

Optional. Number of records to skip before starting to return results. Used only if paging is applied/enforced.

Responses

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "Lidmaatschapsgegevens": [
    ]
}