Announcements

List announcements

Get a list of announcements with optional filters.

get/v1/announcements

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/announcements
  • Auth: HTTP bearer

Query parameters

fieldsstring

Fields to include in response

entityLinkstring

Filter by entity link

status'Active' | 'Expired' | 'Scheduled'

Filter by status

activeboolean

Filter active announcements

domainstring

Filter by domain FQN

limitinteger

Limit the number results

beforestring

Returns list before this cursor

afterstring

Returns list after this cursor

include'all' | 'deleted' | 'non-deleted'

Include deleted announcements

Response

List of announcements

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.