Download YAML

Federation API (2.1.0)

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
{
  • "meta": {
    },
  • "Verenigingsgegevens": [
    ]
}

Accommodations

Accommodation-related operations

Retrieve accommodation data

Retrieve accommodations with address and location data.

Responses

Response samples

Content type
application/json
{
  • "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.

Responses

Response samples

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