client.permission_sets.list

A method of the Permission Sets endpoint.

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

List Permission Sets

API URL: GET /permission_sets

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

Parameters:

archivedstr, optional: The archival status of the items to return. One of: true, false, all. A blank value is read as ‘false’, which is also the default.
authorstr, optional: If specified, return items from any of these authors. It accepts a comma- separated list of user IDs.
limitint, optional: Number of results to return. Defaults to 20. 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 updated_at. Must be one of: updated_at, name, created_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