roles_list: List Roles

In civis: R Client for the 'Civis Platform API'

List Roles

Description

List Roles

Usage

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

Arguments

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

Value

An array containing the following fields:

id	integer, ID of the Role.
name	string, The name of the Role.
slug	string, The slug.
description	string, The description of the Role.

civis documentation built on April 1, 2023, 12:01 a.m.