client.announcements.list

A method of the Announcements endpoint.

list(*, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List announcements

API URL: GET /announcements

import civis
client = civis.APIClient()
response = client.announcements.list(...)

Parameters:

limitint, optional: Number of results to return. Defaults to 10. Maximum allowed is 50.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to released_at. Must be one of: released_at.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse