Help Article

Hilfecenter / Hilfeartikel

Medien2 EndpunkteHelpcenter / Help Article

Liefert eine Liste der Hilfeartikel.

GET/api/help/help_article

Query-Parameter

`name`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`token`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`publicTitle`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`newsType`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`created`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`slugIdentifier`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`publicKeywords`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`publishDate`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`unpublishDate`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`articleSpace`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`viewOrder`integer	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE, C1
`id`integer
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE
`person`string	, C1
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der Hilfeartikel.array<MediaNewsArticle2>

Felder anzeigen (26)

idinteger
Primärschlüssel des Nachrichtenartikels. Interne ID.
news_typestring
Art des Nachrichtenartikels.
tokenstring
Öffentlicher Token des Artikels. Anstelle der ID verwendet.
public_titlestring
Titel, der öffentlich angezeigt wird.
public_copyrightstring
Urheberrechtstext, der mit dem Artikel angezeigt wird.
public_language_codestring
Sprache des Artikels, zum Beispiel de.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_thumbnailstring
URL des Vorschaubildes.
public_keywordsstring
Schlüsselwörter des Artikels.
public_categorystring
Kategorie des öffentlich angezeigten Artikels.
publish_datestring (date-time)
Zeitpunkt, zu dem der Artikel veröffentlicht wird.
unpublish_datestring (date-time)
Zeitpunkt, zu dem der Artikel zurückgezogen wird.
article_spaceMediaArticleSpace6
Artikelbereich, zu dem der Artikel gehört.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Artikelbereichs. Interne ID.
- childrenarray<MediaArticleSpace6>
  Untergeordnete Artikelbereiche.
- parentMediaArticleSpace6
  Übergeordneter Artikelbereich.
- public_keywordsstring
  Schlüsselwörter des Artikelbereichs.
- view_orderinteger
  Sortierreihenfolge des Artikelbereichs in Listen.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- image_urlstring
  URL des Bildes des Datensatzes.
view_orderinteger
Sortierreihenfolge des Artikels in Listen.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
highlightboolean
Diese Eigenschaft markiert eine Entität als hervorgehoben
image_urlstring
URL des Bildes des Datensatzes.
unified_cat_idsobject
IDs der vereinheitlichten Kategorien.
unified_cat_namesobject
Namen der vereinheitlichten Kategorien.
unified_tag_idsobject
IDs der vereinheitlichten Tags.
unified_tag_namesobject
Namen der vereinheitlichten Tags.
slug_identifierstring
Slug, der in URLs der Entität verwendet wird.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/help/help_article \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/help/help_article', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/help/help_article"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/help/help_article', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/help/help_article"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/help/help_article")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/help/help_article"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'package:http/http.dart' as http;

final response = await http.get(
  Uri.parse('https://eure-instanz.iw-erp.de/api/help/help_article'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

[
  {
    "id": 42,
    "public_title": "Beispiel",
    "image_url": "https://vynst.de",
    "news_type": "string",
    "token": "string",
    "public_copyright": "string",
    "public_language_code": "string",
    "public_subtitle": "string",
    "public_author": "string",
    "public_summary": "string"
  }
]

Liefert einen einzelnen Hilfeartikel mit der angegebenen ID oder dem angegebenen Token.

GET/api/help/help_article/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert einen einzelnen Hilfeartikel mit der angegebenen ID oder dem angegebenen Token.MediaNewsArticle9

Felder anzeigen (30)

content_htmlstring
idinteger
Primärschlüssel des Nachrichtenartikels. Interne ID.
news_typestring
Art des Nachrichtenartikels.
tokenstring
Öffentlicher Token des Artikels. Anstelle der ID verwendet.
entriesarray<MediaNewsArticleContent3>
Inhaltsblöcke des Artikels.
Felder anzeigen (6)
- content_htmlstring
- idinteger
  Primärschlüssel des Nachrichtenartikel-Inhalts. Interne ID.
- contentstring
  Inhalt des Blocks.
- content_typestring
  Art des Blocks, zum Beispiel Text, Bild oder Video.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
namestring
Interner Name des Artikels.
public_titlestring
Titel, der öffentlich angezeigt wird.
public_copyrightstring
Urheberrechtstext, der mit dem Artikel angezeigt wird.
public_language_codestring
Sprache des Artikels, zum Beispiel de.
public_subtitlestring
Untertitel, der öffentlich angezeigt wird.
public_authorstring
Öffentlich angezeigter Autor.
public_summarystring
Kurze Zusammenfassung, die öffentlich angezeigt wird.
public_thumbnailstring
URL des Vorschaubildes.
public_keywordsstring
Schlüsselwörter des Artikels.
public_categorystring
Kategorie des öffentlich angezeigten Artikels.
publish_datestring (date-time)
Zeitpunkt, zu dem der Artikel veröffentlicht wird.
unpublish_datestring (date-time)
Zeitpunkt, zu dem der Artikel zurückgezogen wird.
article_spaceMediaArticleSpace12
Artikelbereich, zu dem der Artikel gehört.
Felder anzeigen (12)
- idinteger
  Primärschlüssel des Artikelbereichs. Interne ID.
- childrenarray<MediaArticleSpace12>
  Untergeordnete Artikelbereiche.
- parentMediaArticleSpace12
  Übergeordneter Artikelbereich.
- public_keywordsstring
  Schlüsselwörter des Artikelbereichs.
- view_orderinteger
  Sortierreihenfolge des Artikelbereichs in Listen.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- image_urlstring
  URL des Bildes des Datensatzes.
- visibility_typestring
  Art der Sichtbarkeit des Datensatzes.
- arslistarray<AccessRightStorage7>
  Zugriffsrechteliste, die die Sichtbarkeit steuert.
view_orderinteger
Sortierreihenfolge des Artikels in Listen.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
visibility_typestring
Art der Sichtbarkeit des Datensatzes.
arslistarray<AccessRightStorage7>
Zugriffsrechteliste, die die Sichtbarkeit steuert.
Felder anzeigen (12)
- idinteger
  Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.
- userUser50
  Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.
- access_tagAccessTag
  Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.
- create_mainboolean
  Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.
- edit_mainboolean
  Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.
- read_mainboolean
  Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.
- create_childboolean
  Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).
- edit_childboolean
  Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).
- read_childboolean
  Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
highlightboolean
Diese Eigenschaft markiert eine Entität als hervorgehoben
image_urlstring
URL des Bildes des Datensatzes.
ucatsarray<UnifiedCategory26>
Vereinheitlichte Kategorien des Datensatzes.
Felder anzeigen (32)
- idinteger
  Primärschlüssel der einheitlichen Kategorie. Interne ID.
- category_typestring
  Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.
- childrenarray<UnifiedCategory26>
  Untergeordnete Kategorien.
- parentUnifiedCategory26
  Übergeordnete Kategorie.
- view_orderinteger
  Sortierreihenfolge der Kategorie in Listen.
- is_publicboolean
  Die Kategorie wird öffentlich angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- short_identifierstring
  Kurzkennung der Entität.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- image_urlstring
  URL des Bildes des Datensatzes.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
unified_cat_idsobject
IDs der vereinheitlichten Kategorien.
unified_cat_namesobject
Namen der vereinheitlichten Kategorien.
slug_identifierstring
Slug, der in URLs der Entität verwendet wird.

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/help/help_article/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/help/help_article/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/help/help_article/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/help/help_article/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/help/help_article/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/help/help_article/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/help/help_article/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'package:http/http.dart' as http;

final response = await http.get(
  Uri.parse('https://eure-instanz.iw-erp.de/api/help/help_article/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "image_url": "https://vynst.de",
  "content_html": "string",
  "news_type": "string",
  "token": "string",
  "entries": [
    {
      "id": 42,
      "content_html": "string",
      "content": "string",
      "content_type": "string",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    }
  ],
  "public_copyright": "string",
  "public_language_code": "string"
}