Sign in
News

Get News List

Returns a list of news posts.

get/v1/news

Query parameters

sort_field'slug' | 'title' | 'description' | 'date' | 'datetime' | 'tags' | 'category'
sort_order'asc' | 'desc'
limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

category'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update'
group'event' | 'update' | 'other'
search_stringstring
collection_idstring
state'draft' | 'published'
has_collectionboolean
idsstring

Optional comma separated list of ids

Optional comma separated list of ids

Response

Successful Response

datestring date

The date of the news

tagsstring required

The tags of the news, separated by commas

order_idinteger

The order ID of the news

category'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update' required
published_atinteger

The published date of the news

datetimeinteger required

The date of the news

video_urlstring uri

The URL of the video for the news

is_featuredboolean

Whether the news is featured, which shows its card in large size

collection_idstring

The collection ID this news belongs to

is_pinnedboolean

Whether the news is pinned, which puts it into the article slider

pin_scope'global' | 'collection'

How far a pinned article or page reaches.

  • global: the pin also acts on views spanning sibling collections
  • collection: the pin acts only among the articles of its own collection

An unset scope is read as GLOBAL.

button_textstring

Text for the news card button

idstring required

The unique identifier of the news

slugstring required

The slug of the news

titlestring required

The title of the news

descriptionstring

The description of the news

textstring required

The text of the news

htmlstring

The html content of the news

Changes

Changed in 4 of the 28 revisions of this API.511

  • 1816e2044c0711See the full diff
    • ●

      added the new function enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fb9750c99d0a4See the full diff
    • ●

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

      request-parameter-exclusive-min-set

    • ●

      for the query request parameter collection_id, the maxLength was set to 32

      request-parameter-max-length-set

    • ●

      for the query request parameter limit, the max was set to 300.00

      request-parameter-max-set

    • ●

      for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

  • 5e18ab6733327See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 63f522cab1393See the full diff
    • ○

      added the new optional query request parameter collection_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter has_collection

      new-optional-request-parameter

    • ○

      added the new optional query request parameter state

      new-optional-request-parameter