CLclubplatform
Video

Videos

Returns a list of all unprotected videos. For a list including protected videos, set the include_protected query parameter.

get/clubs/{club_id}/videos

Request

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

Path parameters

club_idinteger required

ID of the club.

Query parameters

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

It returns only items for that locale. Additionally, as side effect 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 ItemsSet locale
✅✅
limitinteger

Maximal number of items per page.

pageinteger

Index of requested page.

sincestring date-time

Returns only items after that time.

untilstring date-time

Returns only items before that time.

source_typestring

Returns only items from the given source type.

include_protectedboolean

Whether to include protected videos in the response.

categoriesstring[]

Returns only items for the given whitelisted categories.

NOTE: if passed category is not whitelisted the result will be empty.

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

OK

Example response

{
  "data": [
    {
      "locale": "de-DE",
      "ranking": 5,
      "prio": true
    }
  ]
}

Changes

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