See api-docs Menu

Get Role

Use this API to return the base role object. Role users, apps, and administrators are returned using sub endpoints.

Resource URL


Header Parameters




Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All, Read Users.

Resource Parameters




Set to the id of the role you want to return.

Sample Responses

    "id": 123,
    "name": "Sample Role"

Typically, this error means that your access token value is invalid.

    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"

The requested role does not exist.

    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Roles API

Sample Code


Replace sample values indicated by < > with your actual values.

Get Role

curl 'https://<subdomain>/api/2/roles/:id' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.