---
title: "List roles"
method: GET
path: "/settings/roles"
tags: ["Admin Settings: Roles"]
---

# List roles

`GET /settings/roles`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/settings/roles`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/settings/roles/get.ts> (a function with typed inputs; its response is checked against the schema)

Datagrid-parity listing. Filters: name (LIKE), permission_type. Sort: id (default desc), name.

## Query parameters

- `page` integer
- `per_page` integer
- `name` string
- `permission_type` 'all' | 'custom'
- `sort` 'id' | 'name'
- `order` 'asc' | 'desc'

## Response `200`

Paginated list in { data, meta } envelope.

- AdminSettingsRole[]
  - `id` integer, nullable
  - `name` string, nullable
  - `description` string, nullable
  - `permissionType` string, nullable
  - `permissions` string[], nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable
  - `message` string, nullable

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)