News

News

Returns a list of news for the club.

get/clubs/{club_id}/news

Request

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

Path parameters

club_idinteger required

ID of the club.

Query parameters

category_idinteger

Returns only items within this category.

category_idsinteger[]

Returns only items within this categories e.g. category_ids[]=1&category_ids[]=2.

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.

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": [
    {
      "id": 42,
      "locale": "de-DE",
      "keywords": [
        "keyword"
      ],
      "author": "Borussia Dortmund",
      "url": "http://www.bvb.de/News/Uebersicht/Ich-will-erfolgreich-sein-und-guten-Fussball-spielen-lassen",
      "highlight": true,
      "prio": true,
      "category": "Nachricht",
      "category_id": 113,
      "additional_categories": [
        {
          "category": "Additional Category 1",
          "id": 17
        },
        {
          "category": "Additional Category 2",
          "id": 22
        }
      ],
      "teaser": {
        "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
        "text": "Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.",
        "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
        "images": [
          {
            "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
            "width": 1140,
            "height": 840,
            "orientation": "landscape",
            "size": {
              "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
              "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
              "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
            },
            "description": "Dezentes grinsen."
          }
        ]
      },
      "components": [
        {
          "title": "„Ich will erfolgreich sein und guten Fußball spielen lassen“",
          "subhead": "Neuer Trainer",
          "text": "Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.",
          "text_original": "<p>Der neue ist Trainer ist da! „Ich bin stolz, dass ich für so einen großen Verein arbeiten darf“, erklärte Peter Bosz bei einer kurzfristig anberaumten Pressekonferenz und fügte hinzu: „Die Gelbe Wand ist legendär.“ Große Ankündigungen waren dem 53 Jahre alte Niederländer von den Medienvertretern jedoch nicht zu entlocken: Freundlich, höflich, aber eben auch angenehm zurückhaltend beantworte er die Fragen.</p>",
          "images": [
            {
              "url": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
              "width": 1140,
              "height": 840,
              "orientation": "landscape",
              "size": {
                "small": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/small_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
                "medium": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/medium_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg",
                "large": "https://keepr.global.ssl.fastly.net/example/image/file/7143751/large_a9d7489d-556d-4147-b4c8-cedff458d8f1.jpg"
              },
              "description": "Dezentes grinsen."
            }
          ]
        }
      ],
      "ranking": 5,
      "send_as_notification": true
    }
  ]
}

Changes

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