Sign in
Roles

This endpoint returns a role by its ID.

get/roles/{roleId}

Query parameters

includestring[]

Response

OK

idstring uuid required

The ID of the role.

assignableboolean

True if the user doing the request can assign this role to other users, false otherwise.

userCountinteger

Count of users that are associated with this role in the account

namestring required

The name of the role.

notesstring

The notes of the role.

defaultboolean required

True if the role is one of the default roles for the account, false otherwise.

Changes

No recorded changes to this endpoint across all 1 revision of this API.