civis (version 3.0.0)

announcements_list: List announcements

Description

List announcements

Usage

announcements_list(
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Value

An array containing the following fields:

id

integer, The ID of this announcement

subject

string, The subject of this announcement.

body

string, The body of this announcement.

releasedAt

string, The date and time this announcement was released.

createdAt

string,

updatedAt

string,

Arguments

limit

integer optional. Number of results to return. Defaults to 10. Maximum allowed is 50.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to released_at. Must be one of: released_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.