---
title: "Get News List"
method: GET
path: "/v1/news"
tags: ["News"]
---

# Get News List

`GET /v1/news`

Returns a list of news posts.

## Query parameters

- `sort_field` 'slug' | 'title' | 'description' | 'date' | 'datetime' | 'tags' | 'category'
- `sort_order` 'asc' | 'desc'
- `limit` integer — A limit on the number of objects to be returned
- `offset` integer — The number of objects to skip
- `category` 'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update'
- `group` 'event' | 'update' | 'other'
- `search_string` string
- `collection_id` string
- `state` 'draft' | 'published'
- `has_collection` boolean
- `ids` string — Optional comma separated list of ids

## Response `200`

Successful Response

- NewsRead[]
  - `date` string, date — The date of the news
  - `image_url` union — The URL of the image for the news
    - string, uri
    - ''
  - `tags` string, required — The tags of the news, separated by commas
  - `order_id` integer — The order ID of the news
  - `category` 'bugfix' | 'company_news' | 'event' | 'maintenance' | 'update', required
  - `published_at` integer — The published date of the news
  - `datetime` integer, required — The date of the news
  - `render_options` NewsRenderOptions
    - `is_promo_store` boolean
  - `video_url` string, uri — The URL of the video for the news
  - `is_featured` boolean — Whether the news is featured, which shows its card in large size
  - `collection_id` string — The collection ID this news belongs to
  - `requirements_expression` Expression
    - `tokens` Token[]
      - `type` 'attribute' | 'custom_attribute' | 'event_attribute' | 'custom_event_attribute' | 'operator' | 'number' | 'date' | 'string' | 'boolean' | 'list' | 'variable' | 'function' | 'virtual_currency', required
      - `value` unknown
    - `name` string
    - `variables` Expression[]
  - `featured_image_url` union — The URL of the featured image for the news
    - string, uri
    - ''
  - `is_pinned` boolean — 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.
  - `pinned_image_url` union — The URL of the pinned image for the news
    - string, uri
    - ''
  - `pinned_webview_image_url` union — The URL of the pinned image for the news (in webview)
    - string, uri
    - ''
  - `custom_url` union — Custom URL that the news card links to instead of the news itself
    - string, uri
    - ''
  - `button_text` string — Text for the news card button
  - `id` string, required — The unique identifier of the news
  - `slug` string, required — The slug of the news
  - `title` string, required — The title of the news
  - `description` string — The description of the news
  - `text` string, required — The text of the news
  - `html` string — The html content of the news

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `1816e2044c07` — 1 warning, 1 info
  - added the new `function` enum value to the `items/requirements_expression/tokens/items/type` response property for the response status `200`
  - added the optional property `items/requirements_expression/name` to the response with the `200` status
- **2026-09-18** `fb9750c99d0a` — 4 warning
  - for the `query` request parameter `limit`, the exclusiveMinimum was set to `1.00`
  - for the `query` request parameter `collection_id`, the maxLength was set to `32`
  - for the `query` request parameter `limit`, the max was set to `300.00`
  - for the `query` request parameter `offset`, the min was set to `0.00`
- **2026-09-15** `5e18ab673332` — 7 info
  - added the optional property `items/button_text` to the response with the `200` status
  - added the optional property `items/custom_url` to the response with the `200` status
  - added the optional property `items/featured_image_url` to the response with the `200` status
  - added the optional property `items/is_pinned` to the response with the `200` status
  - …3 more
- **2026-08-24** `63f522cab139` — 3 info
  - added the new optional `query` request parameter `collection_id`
  - added the new optional `query` request parameter `has_collection`
  - added the new optional `query` request parameter `state`

[Change history](https://skmtc.dev/aghanim/apis/aghanim-server-to-server-api/changes/v1/news/get.md)

---

[API](https://skmtc.dev/aghanim/apis/aghanim-server-to-server-api.md) · [All operations](https://skmtc.dev/aghanim/apis/aghanim-server-to-server-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aghanim/apis/aghanim-server-to-server-api/revisions/32e27bc547ae?raw)