Skip to Content
API ReferencePermissions API

Permissions API

Endpoints for managing permissions in the system.

Get Permissions List

Get the complete list of permissions.

Request

GET /api/permissions

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "permissions": [ { "id": 1, "name": "admin.users", "description": "User management" }, { "id": 2, "name": "admin.roles", "description": "Role management" }, { "id": 3, "name": "admin.pages", "description": "Page management" } ] }

Response Fields

FieldTypeDescription
permissionsarrayArray of permissions
idintegerPermission ID
namestringPermission name
descriptionstringPermission description

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request

Get Permission Data

Get detailed information about a specific permission.

Request

GET /api/permissions/{id}

Path Parameters

NameTypeDescription
idintegerPermission ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "permission": { "id": 1, "name": "admin.users", "description": "User management" } }

Response Fields

FieldTypeDescription
permissionobjectPermission object
idintegerPermission ID
namestringPermission name
descriptionstringPermission description

Response Codes

CodeDescription
200Successful request
401Invalid or missing API key
403Insufficient permissions to perform request
404Permission not found

Create Permission

Create a new permission in the system.

Request

POST /api/permissions

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "name": "admin.settings", "description": "System settings management" }

Request Body Parameters

NameTypeDescription
namestringRequired. Permission name
descriptionstringOptional. Permission description

Response

{ "message": "Permission created successfully", "permission": { "id": 4, "name": "admin.settings", "description": "System settings management" } }

Response Codes

CodeDescription
201Permission successfully created
401Invalid or missing API key
403Insufficient permissions to perform request
422Invalid request parameters

Update Permission

Update data of an existing permission.

Request

PUT /api/permissions/{id}

Path Parameters

NameTypeDescription
idintegerPermission ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key
Content-TypestringRequired. application/json

Request Body

{ "name": "admin.system-settings", "description": "System settings management" }

Request Body Parameters

NameTypeDescription
namestringOptional. Permission name
descriptionstringOptional. Permission description

Response

{ "message": "Permission updated successfully", "permission": { "id": 4, "name": "admin.system-settings", "description": "System settings management" } }

Response Codes

CodeDescription
200Permission successfully updated
401Invalid or missing API key
403Insufficient permissions to perform request
404Permission not found
422Invalid request parameters

Delete Permission

Delete a permission from the system.

Request

DELETE /api/permissions/{id}

Path Parameters

NameTypeDescription
idintegerPermission ID

Headers

NameTypeDescription
X-API-KeystringRequired. API key

Response

{ "message": "Permission deleted successfully" }

Response Codes

CodeDescription
200Permission successfully deleted
401Invalid or missing API key
403Insufficient permissions to perform request
404Permission not found