News Streams

News Streams

News Streams contain items of different types (news/videos/social media posts). Items are freely re-arrangable by editors. The response reflects this ordering and returns the most recent 100 items per stream. Streams are identified by their handles.

get/clubs/{club_id}/news_streams/{handle}

Request

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

Path parameters

club_idinteger required

ID of the club.

handlestring required

Unique identifier of the stream.

You may use default for the handle and it will give you the default news stream. If you have news streams for different locales (e.g., a German and an English one), then default will return the news stream of the selected locale. If you use default without specifying a locale, it will return the default news stream for the access token's locale.

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
✅✅

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

Changes

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