Skip to main content
GET
/
v1
/
roles
/
{roleId}
Get role details
curl --request GET \
  --url https://api.coderabbit.ai/v1/roles/{roleId} \
  --header 'x-coderabbitai-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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

​
include_permissions
boolean
default:true
​
include_user_count
boolean
default:true

Response

200

Successfully retrieved role