BAbagisto
Admin Settings: Roles

List roles

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

get/settings/roles

Request

Query parameters

pageinteger
Example:1

Page number.

per_pageinteger
Example:10

Items per page (default 10, max 50).

namestring

Partial name match.

permission_type'all' | 'custom'

Filter by permission_type.

sort'id' | 'name'
Example:id

Sort column.

order'asc' | 'desc'
Example:desc

Sort direction.

Response

Paginated list in { data, meta } envelope.

idinteger nullable
namestring nullable
descriptionstring nullable
permissionTypestring nullable
permissionsstring[] nullable
createdAtstring nullable
updatedAtstring nullable
messagestring nullable

Example response

[
  {
    "id": 1,
    "name": "Administrator",
    "description": "Full access to all modules",
    "permissionType": "all",
    "permissions": [
      "catalog.products.create",
      "sales.orders.view"
    ],
    "createdAt": "2026-05-25T08:15:00+00:00",
    "updatedAt": "2026-05-25T08:20:00+00:00",
    "message": "Role deleted successfully."
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.