Skip to content

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.

PropertyValue
EndpointFetch All Permissions
MethodGET
URL/api/v1/permissions
AuthenticationBearer Token

Request Headers:

HeaderValueRequired
Acceptapplication/jsonYes
AuthorizationBearer your-auth-tokenYes

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.

PropertyValue
EndpointFetch Grouped Permissions
MethodGET
URL/api/v1/permissions/grouped
AuthenticationBearer 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"}
        ]
    }
}

www.onezeroart.com