List predefined roles

Show all predefined roles.

Processing mode: <small><code>sync</code></small>

get/predefined-roles

Request

Base URL
https://forge.laravel.com/api
Auth
OAuth 2
Authorization codehttps://forge.laravel.com/oauth/authorize
Token URLhttps://forge.laravel.com/oauth/token
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/predefined-roles/get.ts
A function with typed inputs. Its response is checked against the schema.

includestring

Available includes are permissions, permissionsCount, permissionsExists. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

page[cursor]string

The cursor to start the pagination from.

filter[name]string

filter[permissions.name]string

Paginated set of PredefinedRoleResource

No recorded changes to this operation across all 1 revision of this API.