Get a list of Announcements
GET
/api/announcements
deprecated
Requires: Announcements.Management, merchant scope.
Return a list of Announcements based on permissions and optional filters
Parameters
| Name | In | Type | Description |
|---|---|---|---|
Scope
required |
query | WinkPGAnnouncementsAnnouncementScope | Filter by scope. |
Priority
required |
query | WinkPGAnnouncementsAnnouncementPriority | Filter by priority. |
IsEnabled
required |
query | boolean | Filter by enabled status. |
IsActive
required |
query | boolean | Filter by active status (currently within schedule). |
ResellerId
required |
query | string (uuid) | Filter by reseller ID (for reseller-scoped announcements). |
MerchantId
required |
query | string (uuid) | Filter by merchant ID (for merchant-scoped announcements). |
Filter
required |
query | string | Text filter to search in title. |
StartDateFrom
required |
query | string (date-time) | Filter announcements starting after this date. |
StartDateTo
required |
query | string (date-time) | Filter announcements starting before this date. |
Name
required |
query | string | Gets or sets the name filter for the result set. |
IncludeDeleted
required |
query | boolean | Gets or sets a value indicating whether to include deleted entities in the result set. |
IncludeInactive
required |
query | boolean | Gets or sets a value indicating whether to include inactive entities in the result set. |
Ids
required |
query | array of string (uuid) | Gets or sets a list of entity IDs to filter the result set. |
Sorting
required |
query | string | |
SkipCount
required |
query | integer (int32) | |
MaxResultCount
required |
query | integer (int32) | |
ExtraProperties
required |
query | object | |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.