Roles API #

Base path: /roles

GET /roles
Returns a list of roles. Supports filtering, sorting, and includes.

GET /roles/{id}
Returns a single role by ID.

POST /roles
Creates a new role.
Returns the created role.
Possible errors: 422 (validation error)

PUT/PATCH /roles/{id}
Updates an existing role.
Returns the updated role.
Possible errors: 422 (validation error), 404 (role not found)

DELETE /roles/{id}
Deletes a role.
Returns no content on success.
Possible errors: 404 (role not found)

POST /roles/search
Searches roles using filters and query parameters.

GET /roles/{id}/relationships/permissions
Returns permissions related to a role.

GET /roles/{id}/permissions
Returns permissions assigned to a role.

GET /roles/belongs-to/{permission} (custom endpoint)
Returns roles that have a specific permission.

Notes:
Roles include permissions by default in responses.
Filtering and sorting can be applied via query parameters.
Available filters include id, name, active, and guard_name.
Available sorting fields include id, name, and created_at.
Custom scopes such as active and withPermissions can be used for advanced queries.