Retrieve a news item

GET

/v1/news/{id}/

const url = 'https://example.com/v1/news/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/news/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single news item by its ID.

Authorizations

jwtAuth
basicAuth

Parameters

Path Parameters

required

string format: uuid

A UUID string identifying this news.

Responses

200

application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

required

string format: uuid

title

required

string

<= 50 characters

description

string

category

feature - Feature
improvement - Improvement
fix - Fix
tip - Tip
event - Event

string

Allowed values: feature improvement fix tip event

image

string format: uri

nullable

banner_image

string format: uri

nullable

active

required

boolean

publish_at

A published news only becomes visible once this date is reached.

string format: date-time

expire_at

Once this date is reached, the news is no longer visible.

string format: date-time

nullable

cta_label

string

<= 50 characters

cta_url

Call-to-action target: a full URL (https://…, opens in a new tab) or a panel-relative path (e.g. /settings/cloud, opens in the app).

string

<= 200 characters

read

required

boolean

my_reaction

required

string

nullable

reactions

required

object

key

additional properties

integer

created_at

string format: date-time

modified_at

required

string format: date-time

Example

{
  "category": "feature"
}