API Reference

List all roles

get
https://api.controlup.com/v1/organizations//roles

Returns a list of all roles.

Required permission: View Settings

Path Params
uuid
required
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

Query Params
int32
≥ 1
Defaults to 1

The page of results to return.
The first page is page number 1.

int32
≥ 1
Defaults to 10

The number of results returned per page.

string
enum
Defaults to id

Sorts results according to the specified field.

Allowed:
string
enum
Defaults to asc

The sort order (ascending / descending) of the field specified by the _sortBy parameter.

Allowed:
string

A search filter that is applied to all fields.
Only results that contain the specified string are returned.

string
enum
Defaults to json

The format of returned results.

Allowed:
string

Filter roles by a specific tenant manager child organization ID.
Returns roles that apply to this child organization (either roles with no specific child organizations, or roles that include this child organization).

isDefault
array of booleans

A search filter on the isDefault field.

isDefault
description
array of objects

A search filter on the description field.

description
name
array of strings

A search filter on the name field.

name
id
array of strings

A search filter on the id field.

id
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?