List Announcements

Retrieve all announcements for the current tenant with pagination support

GET /api/v2/admin/announcements

cURL

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"

const response = await fetch('/api/v2/admin/announcements?page=1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'X-Tenant-ID': 'your-tenant-id'
  }
});

const data = await response.json();

Response

{
  "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": "[e-mail]"
        },
        "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

Authorization · string · required

Bearer token for authentication

X-Tenant-ID · string · required

The tenant ID to scope the announcements

Query Parameters

page · integer · default: "1"

Page number for pagination

Response

success · boolean

Indicates if the request was successful

data · object

Show data

data · array

Array of announcement objects

Show announcement

id · integer

Unique identifier for the announcement

tenant_id · string

The tenant ID this announcement belongs to

title · string

The announcement title

summary · string

Brief summary of the announcement

content · string

Detailed content of the announcement

type · string

Type of announcement: info, warning, success, alert

priority · integer

Priority level: 0 for normal, 1 for high

status · string

Current status: draft, scheduled, published, archived

is_push_enabled · boolean

Whether push notifications are enabled

is_public · boolean

Whether the announcement is public

scheduled_at · string

ISO timestamp when the announcement is scheduled to be published

expires_at · string

ISO timestamp when the announcement expires

topic · string

Topic category (e.g., PROMOTIONS, SYSTEM, MAINTENANCE)

push_status · string

Push notification status: pending, success, failed

sent_at · string

ISO timestamp when push notification was sent

attachment_type · string

Type of attachment: image, link, button

attachment_url · string

URL of the attachment

created_by · integer

ID of the user who created the announcement

creator · object

Show creator

id · integer

Creator’s user ID

name · string

Creator’s name

email · string

Creator’s email

created_at · string

ISO timestamp when the announcement was created

updated_at · string

ISO timestamp when the announcement was last updated

current_page · integer

Current page number

last_page · integer

Total number of pages

per_page · integer

Number of items per page

total · integer

Total number of announcements

cURL

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"

const response = await fetch('/api/v2/admin/announcements?page=1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'X-Tenant-ID': 'your-tenant-id'
  }
});

const data = await response.json();

Response

{
  "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": "[e-mail]"
        },
        "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
  }
}