News API
Retrieve all news items and announcements
Support
News API
Retrieve a complete list of news items and announcements. Stay informed about platform updates, feature releases, and important notices.
All News
Complete news list.
Notifications
Email alert settings.
Timestamps
Created and updated.
Endpoint Overview
QUERY
/graphqlRetrieve all news items including titles, descriptions, and notification settings.
Authentication:Bearer Token
Required scopes:useradmin
GraphQL Query
query news {
news {
id
title
description
notifyByEmail
createdAt
updatedAt
}
}Variables:
{}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query news { news { id title description notifyByEmail createdAt updatedAt } }",
"variables": {}
}'Response
200News Retrieved Successfully
{
"data": {
"news": [
{
"id": 1,
"title": "New Feature Release",
"description": "We are excited to announce the release of a new feature...",
"notifyByEmail": true,
"createdAt": "2024-08-10T10:00:00Z",
"updatedAt": "2024-08-10T10:00:00Z"
},
{
"id": 2,
"title": "Maintenance Update",
"description": "Scheduled maintenance will occur on...",
"notifyByEmail": false,
"createdAt": "2024-08-09T08:30:00Z",
"updatedAt": "2024-08-09T08:30:00Z"
}
]
}
}Response Fields
idInt!Unique identifier for the news item.
titleString!Title of the news item.
descriptionString!Full description or content of the news item.
notifyByEmailBoolean!Whether email notifications are sent for this news item.
createdAtDateTime!Timestamp when the news item was created.
updatedAtDateTime!Timestamp when the news item was last updated.
Related Endpoints
Email Notifications
Check the notifyByEmail field to determine if users receive email notifications for each news item.
Get Specific News
Retrieve details of a specific news item by ID.