---
title: "News"
method: GET
path: "/clubs/{club_id}/news"
tags: ["News"]
---

# News

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

Returns a list of news for the club.

## Path parameters

- `club_id` integer, required

## Query parameters

- `category_id` integer
- `category_ids` integer[]
- `locale` 'de-DE' | 'en-GB' | 'nl-NL'
- `limit` integer
- `page` integer
- `since` string, date-time
- `until` string, date-time

## Headers

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

## Response `200`

OK

- object
  - `data` object[]: Array of news.
    - `id` integer: ID of the news.
    - `locale` string: Locale of the object. 'de-DE', 'en-GB' or 'nl-NL'. This locale must be whitelisted for your club!
    - `keywords` string[]: Array of keywords that describe the news.
    - `author` string: Author of the news.
    - `url` string, required: URL of the original news.
    - `highlight` boolean: Special type of news.
    - `prio` boolean
    - `category` string, required: Category of the news.
    - `category_id` integer: Category ID of the news.
    - `additional_categories` object[]: List of categories (maximum 10)
      - `category` string: Category Name.
      - `category_id` integer: Category ID.
    - `state` 'in_progress' | 'processed': * in_progress - Currently processing by the server. * processed - Processing is finished.
    - `created_at` string, date-time, required: The UTC date/time at which the current object was created.
    - `published_at` string, date-time: The UTC date/time at which the news item was published.
    - `teaser` object, required: Contains the headline and a short summary.
      - `title` string, required: Main title of the news.
      - `text` string, required: Teaser text with HTML entities and duplicate newlines removed as well as HTML tags, where appropriate, replaced with plain text alternatives (such as br -> \n).
      - `text_original` string: Original/untouched text of the news component
      - `images` object[], required: List of images.
        - `url` string, required: URL of the image.
        - `width` integer: Width of the image.
        - `height` integer: Height of the image.
        - `orientation` string: Orientation of the image. "landscape", "square" or "portrait"
        - `size` object: Different sizes of the teaser image.
          - `small` string: URL to the small sized image.
          - `medium` string: URL to the medium sized image.
          - `large` string: URL to the large sized image.
        - `description` string, required: Descriptive text for the image.
        - `copyright` string: Copyright holder of the image.
    - `components` object[], required: List of components to display the news.
      - `title` string, required: Headline of the component.
      - `subhead` string: Sub headline for the component.
      - `text` string, required: Text with HTML entities and duplicate newlines removed as well as HTML tags, where appropriate, replaced with plain text alternatives (such as br -> \n).
      - `text_original` string: Original/untouched text of the news component
      - `images` object[], required: List of images.
        - `url` string, required: URL of the image.
        - `width` integer: Width of the image.
        - `height` integer: Height of the image.
        - `orientation` string: Orientation of the image. "landscape", "square" or "portrait"
        - `size` object: Different sizes of the teaser image.
          - `small` string: URL to the small sized image.
          - `medium` string: URL to the medium sized image.
          - `large` string: URL to the large sized image.
        - `description` string, required: Descriptive text for the image.
        - `copyright` string: Copyright holder of the image.
    - `ranking` integer: The value of ranking can be between 1 to 100 or null. If ranking_feature of this club is disabled it will always be null
    - `send_as_notification` boolean

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