List Roles

See the roles you can assign, including the global roles MindCloud provides to every company.

GET

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

Unique id of the role.

namestring

The role's name.

descriptionstring

The role's description. Empty when nobody wrote one.

isAdminboolean

True if the role grants admin rights.

isGlobalboolean

True for roles MindCloud provides to every company. Global roles are read-only: writing one answers 404.

createdOndate

When the role was created.

memberCountnumber

How many people in the company hold the role, people whose invite is pending included. A role with members cannot be deleted.