API

Nachrichten abrufen

GET/api/crm/v2/newsv2
operationId: news.default

Gibt Nachrichten mit Übersetzung in die Sprache des Benutzers zurück. Ein numerisches Segment in der URL gibt einen einzelnen Eintrag mit dieser id zurück.

Autorisierung

api-token + language + role

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_rangeobject (FilterDateRange)

Vordefinierte Datumsfilterzeiträume; die Untergrenze wird in der Zeitzone des Benutzers berechnet. value — der Zeitraum, dem die aktuellen *_from und *_to entsprechen; null — benutzerdefinierter Zeitraum. default — der Zeitraum, den der Server bei Anfragen ohne Datumsangaben verwendet: Er wird auch beim ersten Laden des Bereichs angewendet und bei Zurücksetzen wiederhergestellt. Das obere Ende des Zeitraums entspricht immer dem aktuellen Tag des Benutzers, daher enthält option dieses nicht: Für vordefinierte Zeiträume muss *_to nicht übergeben werden, der Server setzt es automatisch. Zeiträume, die länger als ein Jahr sind, werden an der aktuellen Grenze abgeschnitten.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

date_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object
idintegererforderlich

Beispiel: 1

date_publicationstring (DataTimeFormatSQL) erforderlich

Beispiel: 2024-05-02 08:31:16

titlestringerforderlich

Beispiel: News item

imagestring

Beispiel: https://cdn.foodsoul.test/news/39.jpg?v1724923848

contentstringerforderlich

Beispiel: Best regards, the FoodSoul team

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false

Nicht gefunden