--- title: "Schedule of current season for club" method: GET path: "/clubs/{club_id}/current_seasons/schedule" tags: ["Schedule"] --- # Schedule of current season for club `GET /clubs/{club_id}/current_seasons/schedule` ## Request - Base URL: `https://api.clubplatform.de/api` - URL: `https://api.clubplatform.de/api/clubs/{club_id}/current_seasons/schedule` - Auth: API key in query parameter `auth_token` Returns list of scheduled matches of current season where the club is member of. Matches returns in date and start time order. You could also fetch the schedule in iCalendar format if you set `Accept: text/calendar` or use the `.ics` extension. ## Path parameters - `club_id` integer, required ## Query parameters - `alignment` 'away' | 'home' - `group_id` integer - `tournament_ids[]` integer[] - `previous` integer - `next` integer - `locale` 'de-DE' | 'en-GB' | 'nl-NL' ## Headers - `If-Modified-Since` string, date-time ## Response `200` OK - object - `date` object[]: Array of scheduled matches, ordered by date and start time. - `id` integer: ID of the match. - `live` boolean: True when the match is currently running. - `in_break` boolean: True when the match is currently in halftime break. - `has_overtime` boolean: True when the match had a or is currently in first 15 minutes of overtime. - `has_overtime_2` boolean: True when the match had a or is currently in second 15 minutes of overtime. - `has_penalty_shootout` boolean: True when match had a or is currently in penalty shootout. - `start_date_time` string, date-time: Date and time when the game starts. - `start_date_time_quality` 'assumed' | 'definite': | value | description | |:-----------|:--------------------------------------------------| | `assumed` | `start_date_time` is planed but are not definite. | | `definite` | `start_date_time` is definite. | - `start_weekday` string: Day of week in which the match starts. - `event_status` 'pre-event' | 'post-event' | 'mid-event' | 'halted' | 'canceled' | 'forfeited' | 'postponed' | 'rescheduled' | 'delayed': State of the match. | value | description | |:--------------|:--------------------------------| | `pre-event` | upcoming match | | `post-event` | past match | | `mid-event` | running match | | `halted` | match aborted | | `canceled` | match was canceled | | `forfeited` | match was decided off the field | | `postponed` | match was postponed | | `rescheduled` | match was given a new date | | `delayed` | match started later | - `group` object: Group the match is placed in. - `id` integer: ID of group. - `name` string: Name of group. - `site` object: Location where the match will happen. - `id` integer: ID of location. - `name` string: Name of the location. - `built` integer: Year when the venue was built. - `roof` boolean: True when venue has a roof. - `seats` integer: Number of seats/capacity. - `surface` 'artificial_turf' | 'turf': Surface of the stadium. - `url` string: URL to the website of the venue. - `city` string: City of the venue. - `postal_code` string: Postal code of the location. - `street` string: Street of the location. - `lat` number, float: Latitude of the location. - `lng` number, float: Longitude of the location. - `pitch` object: Size of the pitch. - `x` integer: Length of the pitch. - `y` integer: Width of the pitch. - `teams` object[]: List of teams for this match. - `id` integer: ID of the team. - `name` string: Name of the team. - `nickname` string: Nickname of the team. - `handle` string: Handle of the team. - `lineup_complete` string: True when lineup is completed. - `alignment` 'away' | 'home': Alignment of the team. - `score` object: Score of this team in this match. - `final` integer: Final score of the match. - `period_1` integer: Score in the first period. - `period_2` integer: Score in the second period. - `period_3` integer: Score in the first period of overtime. - `period_4` integer: Score in the second period of overtime. - `period_5` integer: Score in the penalty shootout. - `club` object - `id` integer: ID of the club. This **SHALL NOT** change for a club. - `link` string: API-URL to this club. - `emblem` object: The club emblem in different resolutions. - `medium` string: URL to the image in medium resolution (300x300>). - `mini` string: URL to the image in mini resolution (36x36>). - `small` string: URL to the image in mini resolution (70x70>). - `liveticker` object: Informations about the liveticker. - `comments_available` boolean: True when liveticker comments are available. - `matchday` object: Informations about the matchday. - `available` boolean: True when matchday is available. - `live` boolean: True when matchday is currently live. - `link` string: API URL to the matchday. - `video_id` integer: This match's associated video ID, if existent. - `match_name` string: optional name of the match. - `tournament` object: Tournament the match belongs to. - `id` integer: ID of tournament. - `name` string: Name of tournament. - `handle` string: Handle of tournament. - `number_of_rounds` integer: Number of rounds in this tournament. Is `null` when the tournaments has no rounds. - `seasons_link` string: API URL to seasons endpoint of this tournament - `logo` object: URL to logo in different resultions. - `medium` string: URL to logo in medium resolution (300x300). - `mini` string: URL to logo in mini resolution (30x30). - `icon_mini` string: URL to logo in icon resolution (24x24). - `season` object: Season the match belongs to. - `id` integer: ID of the season. - `name` string: Name of the season. - `tournament_id` integer: ID of tournament where season belongs to. - `number_of_rounds` integer: Number of rounds in this season. - `season_teams_link` string: API URL to teams endpoint fot this season - `season_standing_link` string: API URL to standing endpoint fot this season - `season_schedule_link` string: API URL to schedule endpoint fot this season - `season_goalgetter_link` string: API URL to goalgetter endpoint fot this season - `season_scorer_link` string: API URL to scorer endpoint fot this season - `season_fairness_link` string: API URL to fairness endpoint fot this season - `round` object: Round the match belongs to. - `id` integer: ID of round. - `name` string: Name of round. - `division` object: Division the match belongs to. - `id` integer: The id of the division - `name` string: Name of the division **NOTE**: the info will always be in the locale which is provide ## Other responses - `304`: Not Modified - `401`: Unauthorized - `404`: Not Found --- [API](https://skmtc.dev/clubplatform/apis/clubplatform-api.md) - [All operations](https://skmtc.dev/clubplatform/apis/clubplatform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clubplatform/apis/clubplatform-api/revisions/5c107a185e03?raw)