---
title: "Get Custom Role"
method: GET
path: "/custom_role/{custom_role_api_id}"
tags: ["Custom Roles"]
---

# Get Custom Role

`GET /custom_role/{custom_role_api_id}`

Get the details of a specific Custom Role.

## Path parameters

- `custom_role_api_id` string, required

## Query parameters

- `org_id` integer

## Response `200`

OK

- CustomRoleDetail — Detailed representation of a Custom Role
  - `name` string — Name of the Custom Role. Cannot contain any of the following characters: `,;/\|<>`.
  - `api_id` string — API identifier of the Custom Role. Cannot contain any of the following characters: `,;/\|<>`.
  - `description` string
  - `org_id` integer — Unique identifier of an organization in Partoo.
  - `is_builtin` boolean
  - `permissions` string[]

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action
- `404` — Resource does not exist

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)