GET /clubs/{club_id}/calendars/{id}

Calendar

Returns a calendar by ID.

You could also fetch the calendar in iCalendar format if you set Accept: text/calendar or use the .ics extension.

get/clubs/{club_id}/calendars/{id}

Request

Base URL
https://api.clubplatform.de/api
URL
https://api.clubplatform.de/api/clubs/{club_id}/calendars/{id}
Auth
API key in query parameter auth_token

Path parameters

club_idinteger required

ID of the club.

idinteger required

ID of the calendar.

Query parameters

categories[]string[]

List of categories.

locale'de-DE' | 'en-GB' | 'nl-NL'

The response will be in that locale.

NOTE: The locale must be whitelisted for your club! If not the locale for the auth_token will be used as default.

Filter Items	Set locale
❌	✅

Headers

If-Modified-Sincestring date-time

This makes the request conditional - the server will send back the requested resource, with a 200 status, only if it has been last modified after the given date. If the request has not been modified since, the response will be a 304 without any body; the Last-Modified header will contain the date of last modification.

You MUST set this header, if you can, to respect API caching.

Response

Example response

{
  "data": {
    "id": "42",
    "title": "BVB Kalender",
    "timezone": "Europe/Berlin",
    "locale": "de-DE",
    "events": [
      {
        "title": "Borussia Dortmund - Bayern München",
        "uid": "0af1d91b227c6ae77e42e558443cb60e@bvb.de",
        "starts_at": "2016-08-14T18:30:00Z",
        "ends_at": "2016-08-14T20:30:00Z",
        "categories": [
          "Spiel",
          "pro match"
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.