Support

List all News

Returns a list of your News entries. Each entry can be scoped to specific partners and/or locations via the partners and locations fields (empty value means available to all partners / locations).

get/admin/support/news

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/support/news
  • Auth: HTTP basic

Response

idnumber

News ID.

titlestring

News title.

textstring

News body (HTML allowed).

descriptionstring

Short text shown in the news list.

partnersstring[]

List of partner IDs the news is targeted to. Empty array means available to all partners.

locationsstring[]

List of location IDs the news is targeted to. Empty array means available to all locations.

datestring

Publication date. Format: YYYY-MM-DD.

Example response

[
  {
    "id": 1,
    "title": "Maintenance window",
    "text": "<p>Service will be unavailable on Sunday 02:00-04:00.</p>",
    "description": "Planned maintenance on Sunday",
    "partners": [
      "1",
      "2"
    ],
    "locations": [
      "1"
    ],
    "date": "2026-03-15"
  }
]

Changes

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