---
title: "List Custom Roles"
method: GET
path: "/custom_role"
tags: ["Custom Roles"]
---

# List Custom Roles

`GET /custom_role`

Get all Custom Roles for your organization.

## Query parameters

- `page` integer
- `per_page` integer
- `org_id` integer
- `only_available_roles` boolean

## Response `200`

OK

- CustomRoleGetResponse — A list of Custom Roles is returned upon success.
  - `page` integer — Current page number
  - `max_page` integer — Last page number
  - `count` integer — Total number of Custom Roles found.
  - `custom_roles` CustomRoleListItem[] — The list of Custom Roles.
    - `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

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[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)