Skip to main content
GET
Get role details

Get Role Details

Retrieves one built-in or Enterprise custom role. Use the include_permissions and include_user_count query parameters to include additional details in the response. For more information, see Role-based access.

Authorizations

x-coderabbitai-api-key
string
header
required

API key for authentication. You can create an API key from the CodeRabbit dashboard.

Path Parameters

roleId
string
required

Query Parameters

org_id
string

Required when authenticating with a workspace-scoped API token: the git-provider organization id to target within the token's workspace. Ignored for organization and self-hosted keys.

include_permissions
boolean
default:true
include_user_count
boolean
default:true

Response

200

Successfully retrieved role