API documentation
Announcements
Copy
curl -X GET "https://api.example.com/api/v2/admin/announcements?page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "X-Tenant-ID: your-tenant-id"
Copy
{
"success": true,
"data": {
"data": [
{
"id": 1,
"tenant_id": "tenant-123",
"title": "System Maintenance Scheduled",
"summary": "We will be performing scheduled maintenance on our servers.",
"content": "Our servers will be undergoing scheduled maintenance on Sunday, December 15th from 2:00 AM to 4:00 AM EST. During this time, you may experience brief service interruptions.",
"type": "warning",
"priority": 1,
"status": "published",
"is_push_enabled": true,
"is_public": false,
"scheduled_at": null,
"expires_at": "2024-12-16T00:00:00Z",
"topic": "SYSTEM",
"push_status": "success",
"sent_at": "2024-12-11T10:00:00Z",
"attachment_type": null,
"attachment_url": null,
"created_by": 1,
"creator": {
"id": 1,
"name": "Admin User",
"email": "[email protected]"
},
"created_at": "2024-12-11T09:30:00Z",
"updated_at": "2024-12-11T10:00:00Z"
}
],
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1
}
}
Announcements
List Announcements
Retrieve all announcements for the current tenant with pagination support
GET
/
api
/
v2
/
admin
/
announcements
Copy
curl -X GET "https://api.example.com/api/v2/admin/announcements?page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "X-Tenant-ID: your-tenant-id"
Copy
{
"success": true,
"data": {
"data": [
{
"id": 1,
"tenant_id": "tenant-123",
"title": "System Maintenance Scheduled",
"summary": "We will be performing scheduled maintenance on our servers.",
"content": "Our servers will be undergoing scheduled maintenance on Sunday, December 15th from 2:00 AM to 4:00 AM EST. During this time, you may experience brief service interruptions.",
"type": "warning",
"priority": 1,
"status": "published",
"is_push_enabled": true,
"is_public": false,
"scheduled_at": null,
"expires_at": "2024-12-16T00:00:00Z",
"topic": "SYSTEM",
"push_status": "success",
"sent_at": "2024-12-11T10:00:00Z",
"attachment_type": null,
"attachment_url": null,
"created_by": 1,
"creator": {
"id": 1,
"name": "Admin User",
"email": "[email protected]"
},
"created_at": "2024-12-11T09:30:00Z",
"updated_at": "2024-12-11T10:00:00Z"
}
],
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1
}
}
Headers
Bearer token for authentication
The tenant ID to scope the announcements
Query Parameters
Page number for pagination
Response
Indicates if the request was successful
Show data
Show data
Array of announcement objects
Show announcement
Show announcement
Unique identifier for the announcement
The tenant ID this announcement belongs to
The announcement title
Brief summary of the announcement
Detailed content of the announcement
Type of announcement:
info, warning, success, alertPriority level:
0 for normal, 1 for highCurrent status:
draft, scheduled, published, archivedWhether push notifications are enabled
Whether the announcement is public
ISO timestamp when the announcement is scheduled to be published
ISO timestamp when the announcement expires
Topic category (e.g., PROMOTIONS, SYSTEM, MAINTENANCE)
Push notification status:
pending, success, failedISO timestamp when push notification was sent
Type of attachment:
image, link, buttonURL of the attachment
ID of the user who created the announcement
ISO timestamp when the announcement was created
ISO timestamp when the announcement was last updated
Current page number
Total number of pages
Number of items per page
Total number of announcements
Copy
curl -X GET "https://api.example.com/api/v2/admin/announcements?page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "X-Tenant-ID: your-tenant-id"
Copy
{
"success": true,
"data": {
"data": [
{
"id": 1,
"tenant_id": "tenant-123",
"title": "System Maintenance Scheduled",
"summary": "We will be performing scheduled maintenance on our servers.",
"content": "Our servers will be undergoing scheduled maintenance on Sunday, December 15th from 2:00 AM to 4:00 AM EST. During this time, you may experience brief service interruptions.",
"type": "warning",
"priority": 1,
"status": "published",
"is_push_enabled": true,
"is_public": false,
"scheduled_at": null,
"expires_at": "2024-12-16T00:00:00Z",
"topic": "SYSTEM",
"push_status": "success",
"sent_at": "2024-12-11T10:00:00Z",
"attachment_type": null,
"attachment_url": null,
"created_by": 1,
"creator": {
"id": 1,
"name": "Admin User",
"email": "[email protected]"
},
"created_at": "2024-12-11T09:30:00Z",
"updated_at": "2024-12-11T10:00:00Z"
}
],
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 1
}
}
⌘I