Skip to content
Home/
REST API Reference
/
/
Retrieve a role

Retrieve a role

Request

You can fetch the details of a single role by its id, including its description, which the teammates endpoint does not return.

Security
bearerAuth
Path
idstringrequired

The unique identifier of a given role.

Example:991267902
Headers
Intercom-Versionstring(intercom_version_preview)

Preview Intercom API version. Used for closed beta endpoints or other features under managed availability.

Default:"Preview"
Value:"Preview"
Example:Preview
curl -i -X GET \
  https://api.intercom.io/roles/991267902 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

successful

Bodyapplication/json
typestring

Value is always "role"

Example:"role"
idstring

The id of the role

Example:"991267902"
namestring

The name of the role

Example:"Support Lead"
descriptionstring or null

The description of the role

Example:"Can view and reply to conversations"
Response
{
  "type": "role",
  "id": "991267902",
  "name": "Support Lead",
  "description": "Can view and reply to conversations"
}