GET /announcements
Paginated query of announcement list, supporting filtering by status and keyword search. Reference: CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance.
Notification Service `bearerAuth` application/json
Request Parameters
| Name | In | Type | Required | Default | Example | Constraints | Description |
|---|
page |
query |
integer |
No |
1 |
|
|
Page number |
page_size |
query |
integer |
No |
20 |
|
|
Items per page |
status |
query |
string |
No |
|
|
|
Status filter: draft/scheduled/published/expired |
search |
query |
string |
No |
|
|
|
Search keyword |
Referenced Schemas
dto.AnnouncementListResponse
| Field | Type | Required | Example | Constraints | Description |
|---|
code |
integer |
No |
|
|
|
items |
array of
See dto.AnnouncementResponse |
No |
|
|
Unified use of items |
message |
string |
No |
|
|
|
pagination |
object |
No |
|
|
Pagination info (nested object) |
timestamp |
string |
No |
|
|
|
total |
integer |
No |
|
|
Total count (flattened for direct reading) |
dto.AnnouncementResponse
Announcement info response
| Field | Type | Required | Example | Constraints | Description |
|---|
content |
string |
No |
The system will undergo upgrade maintenance on 2026-05-15 |
|
|
created_at |
string |
No |
2026-05-09T12:00:00Z |
|
|
dismissals |
integer |
No |
5 |
|
|
expire_at |
string |
No |
2026-05-20T12:00:00Z |
|
|
id |
string |
No |
ann_abc123 |
|
|
publish_at |
string |
No |
2026-05-10T12:00:00Z |
|
|
status |
string |
No |
published |
|
|
target_roles |
array of
string |
No |
|
|
|
tenant_id |
string |
No |
tnt_xyz789 |
|
|
title |
string |
No |
System upgrade announcement |
|
|
updated_at |
string |
No |
2026-05-09T12:00:00Z |
|
|
views |
integer |
No |
100 |
|
|
gitee_com_linmes_authms_base_dto.PageInfo
| Field | Type | Required | Example | Constraints | Description |
|---|
has_next |
boolean |
No |
|
|
HasNext indicates whether there is a next page |
has_prev |
boolean |
No |
|
|
HasPrev indicates whether there is a previous page |
page |
integer |
No |
|
|
Page is the current page number (1-based) |
page_size |
integer |
No |
|
|
PageSize is the number of items per page |
total |
integer |
No |
|
|
Total is the total number of items across all pages |
total_pages |
integer |
No |
|
|
TotalPages is the total number of pages |
gitee_com_linmes_authms_base_dto.SimpleResponse
| Field | Type | Required | Example | Constraints | Description |
|---|
code |
integer |
No |
|
|
|
message |
string |
No |
|
|
|
timestamp |
string |
No |
|
|
|
Autional API Wiki