---
title: "Launch screen"
method: GET
path: "/clubs/{club_id}/launch_screen"
tags: ["Launch Screen"]
---

# Launch screen

`GET /clubs/{club_id}/launch_screen`

## Request

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

Data backing this club's mobile application's launch screen.

If the club has a [File](#tag/File) with handle `splash_unique_size`,
this file's URL is returned as `splash_screen_image_url`.

If the club has a [Custom Field](#tag/Custom-Field) with key `netradio_link`,
this field's value is returned as `netradio_url`.

## Path parameters

- `club_id` integer, required

## Query parameters

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

## Headers

- `If-Modified-Since` string, date-time

## Response `200`

OK

- object
  - `data` object
    - `upcoming_match_id` integer: ID of this club's ongoing or upcoming match.
    - `upcoming_match_starts_at` string, date-time
    - `upcoming_match_event_status` string: 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 |
    - `upcoming_match_scores` object
      - `home` integer: The home team's goal score.
      - `guest` integer: The guest team's goal score.
    - `upcoming_match_tournament_id` integer: Tournament ID of this club's ongoing or upcoming match.
    - `upcoming_match_tournament_name` string: Tournament name of this club's ongoing or upcoming match. **NOTE**: the info will always be in the locale which is provide
    - `upcoming_match_home_match` boolean: Whether this club's ongoing or upcoming match is a home match.
    - `upcoming_match_liveticker_available` boolean: Whether this club's ongoing or upcoming match has match commentary.
    - `upcoming_match_venue_name` boolean: Venue name of this club's ongoing or upcoming match.
    - `upcoming_match_name` string: optional name of the ongoing or upcoming match.
    - `splash_screen_image_url` string: An image URL to the splash screen image.
    - `emergency_mode` boolean: Whether this club is is emergency mode.
    - `netradio_url` string: An audio URL to this club's netradio broadcast.
    - `upcoming_match_opponent_name` string: The name of this club's upcoming opponent.
    - `upcoming_match_opponent_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>).
    - `upcoming_match_matchday_live` boolean: Whether this club's ongoing or upcoming match has an active Matchday stream.
    - `minutes_elapsed` integer: an integer representing the current minute of a match
    - `injury_time_elapsed` integer: Elapsed injury time in minutes.
    - `period` integer: Period in which the team won the corner.
    - `in_break` boolean: True when the match is currently in halftime break.
    - `period_minutes_elapsed` integer: Minute of the period in which the person receives the card
    - `upcoming_event_id` integer: ID of the next upcoming event for this club.
    - `upcoming_event_starts_at` string, date-time: Date and time when the next upcoming event for this club starts.
    - `upcoming_event_name` string: Name of the next upcoming event for this club.
    - `upcoming_event_stream_live` boolean: Whether the next upcoming event for this club has an active event stream.
    - `upcoming_event_venue_name` string: Venue name of the next upcoming event for this club.
    - `upcoming_occasion_type` string: Type of the next upcoming occasion for this club for example: "match", "event", "etc.".

## 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)