News

Get News List

Changed on

Returns a list of news posts.

get/v1/news

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/news
  • Auth
    HTTP bearer

Query parameters

article_sort'newest_first' | 'oldest_first' | 'manual'

How a collection orders its articles.

  • newest_first: by date, the most recent first
  • oldest_first: by date, the earliest first
  • manual: in the order set by hand

Orders the list the way a collection with this article sort orders its articles

limitinteger

A limit on the number of objects to be returned

offsetinteger

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

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

  • 0ef278347679Revision changes
    • warning

      deleted the query request parameter sort_field

    • warning

      deleted the query request parameter sort_order

    • info

      added the new optional query request parameter article_sort

    • info

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

    • info

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

  • 1816e2044c07Revision changes
    • warning

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

    • info

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