Roles

class Roles(session_kwargs, client, return_type='raw')

Civis API /roles endpoint:

import civis
client = civis.APIClient()
# Call client.roles.<method>(<arguments>) to make a request, e.g.:
client.roles.list(...)

Methods

list(*[, limit, page_num, order, order_dir, ...])

List Roles

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

List Roles

API URL: GET /roles

Parameters:

limitint, optional: Number of results to return. Defaults to 50. Maximum allowed is 1000.
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 id. Must be one of: id.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
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