- Home
- Models
- Groups
Groups
Groups contain many users and allow permissions to be easily managed.
Groups fields
Field |
Type |
Fillable |
Reference |
id
|
Integer
|
|
|
The unique ID to identify the group
|
Groups relations
permissions,
users,
Groups endpoints
GET List all Groups /groups toggle
Paramaters
There are no parameters for this endpoint
Example response
GET Return data for a specified Group /groups/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the group
Paramaters
There are no parameters for this endpoint
Example response
POST Save, or update a Group /groups/:id? toggle
Only custom groups can be modified.
URL slugs
- id
-
String
Leave the ID blank to create a new group.
Paramaters
- name
-
String
The name of the group.
Required
- permissions
-
Array
Pass a list of permission IDs or keys. Any permissions not in this array will be removed from the goup.
DELETE Delete a Group /groups/:id toggle
Only custom groups can be deleted.
URL slugs
- id
-
Integer
The unique ID to identify the group
Paramaters
There are no parameters for this endpoint