Skip to main content
GET
Get all announcements

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
start_date,
end_date,
severity,
is_active,
created_at,
updated_at,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
is_active
boolean | null

Filter by live status: true returns announcements that are currently active (the is_active flag is on and now falls within the start/end date range), false returns the rest. Omit to return all.

severity
enum<string> | null

Filter by severity (low, medium, high).

Mevcut seçenekler:
low,
medium,
high
start_date_from
string<date-time> | null

Filter announcements whose start date is on or after this date (inclusive).

start_date_to
string<date-time> | null

Filter announcements whose start date is on or before this date (inclusive).

end_date_from
string<date-time> | null

Filter announcements whose end date is on or after this date (inclusive).

end_date_to
string<date-time> | null

Filter announcements whose end date is on or before this date (inclusive).

created_at_from
string<date-time> | null

Filter announcements created on or after this date (inclusive).

created_at_to
string<date-time> | null

Filter announcements created on or before this date (inclusive).

Yanıt

Paginated set of AnnouncementResource

data
AnnouncementResource · object[]
gerekli
meta
object
gerekli