Account
Permissions
Get Permissions Grouped

Get Permissions Grouped API

Welcome to the documentation for the Get Permissions Grouped API. This API returns grouped permission if param is true.

Base URL

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

Query Parameters

ParameterTypeSourceRequiredDescription
groupedbooleanbody✅ YesA true or false value

Sample Request

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

Sample 200 Response

{
  "message": "Permissions retrieved successfully",
  "data": {
    "user_management": [
      {
        "_id": "5f8d0a8b0b7e5d1f1f2a3b4c",
        "name": "create_user",
        "description": "Grants permission to create a user",
        "scope": "user_management",
        "__v": 0,
        "createdAt": "2023-07-25T10:10:16.579Z",
        "updatedAt": "2023-07-25T10:10:16.579Z"
      },
      {
        "_id": "5f8d0a8b0b7e5d1f1f2a3b4e",
        "name": "edit_user",
        "description": "Grants permission to edit a user",
        "scope": "user_management",
        "__v": 0,
        "createdAt": "2023-07-25T10:10:16.580Z",
        "updatedAt": "2023-07-25T10:10:16.580Z"
      }
    ],
    "transaction": [
      {
        "_id": "5f8d0a8b0b7e5d1f1f2a3b4d",
        "name": "create_transaction",
        "description": "Grants permission to create a transaction",
        "scope": "transaction",
        "__v": 0,
        "createdAt": "2023-07-25T10:10:16.580Z",
        "updatedAt": "2023-07-25T10:10:16.580Z"
      }
    ]
  },
  "success": true
}
Get PermissionsAccount Lookup