Appearance
User - Permissions
Base URL:
https://your-domain.com
Admin endpoints for managing system permissions. All endpoints require admin authentication.
Fetch All Permissions
Retrieve all available permissions in the system.
| Property | Value |
|---|---|
| Endpoint | Fetch All Permissions |
| Method | GET |
| URL | /api/v1/permissions |
| Authentication | Bearer Token |
Request Headers:
| Header | Value | Required |
|---|---|---|
Accept | application/json | Yes |
Authorization | Bearer your-auth-token | Yes |
Success Response (200 OK):
json
{
"success": true,
"data": [
{
"id": 1,
"name": "subscribers.view",
"display_name": "View Subscribers",
"group": "subscribers"
},
{
"id": 2,
"name": "subscribers.create",
"display_name": "Create Subscribers",
"group": "subscribers"
}
]
}Fetch Grouped Permissions
Retrieve permissions organized by group/module.
| Property | Value |
|---|---|
| Endpoint | Fetch Grouped Permissions |
| Method | GET |
| URL | /api/v1/permissions/grouped |
| Authentication | Bearer Token |
Success Response (200 OK):
json
{
"success": true,
"data": {
"subscribers": [
{"id": 1, "name": "subscribers.view", "display_name": "View"},
{"id": 2, "name": "subscribers.create", "display_name": "Create"},
{"id": 3, "name": "subscribers.update", "display_name": "Update"},
{"id": 4, "name": "subscribers.delete", "display_name": "Delete"}
],
"packages": [
{"id": 5, "name": "packages.view", "display_name": "View"},
{"id": 6, "name": "packages.create", "display_name": "Create"}
]
}
}