Primus Documentation

Get Permissions API

Welcome to the documentation for the Get Permissions API. This API returns all permissions.

Base URL

{baseURL}/v1/accounts/settings/permissions?grouped=true | GET

Query Parameters

Parameter	Type	Source	Required	Description
grouped	boolean	body	✅ Yes	A true or false value

Sample Request

curl -X GET {baseURL}/v1/accounts/settings/permissions?grouped=true \
  -H 'Content-Type: application/json' \

Sample 200 Response

{
  "message": "Permissions retrieved successfully",
  "data": [
    {
      "_id": "5f8d0a8b0b7e5d1f1f2a3b4c",
      "name": "create_user",
      "description": "Grants permission to create a user",
      "scope": "user_management",
      "__v": 0,
      "createdAt": "2023-07-25T10:03:05.031Z",
      "updatedAt": "2023-07-25T10:03:05.031Z"
    }
  ],
  "success": true
}

Update Role Permissions Get Permissions Grouped