Skip to content

Get Role

GET /api/role/{id}

Required privilege: Users / View

Returns a role with its full privilege list, including granular filter configuration.


Path Parameters

Parameter Type Required Description
id integer Yes Internal role identifier

Response

{
  "data": {
    "id": 3,
    "Role Name": "Procurement Manager",
    "Role Description": "Full procurement read/write, demand read",
    "Privileges": [
      {
        "id": 10,
        "Privilege Type": "Procurement",
        "Privilege Description": "Purchase order management",
        "Privilege Access": "Edit"
      },
      {
        "id": 11,
        "Privilege Type": "Demand",
        "Privilege Description": "Sales order visibility",
        "Privilege Access": "View"
      }
    ],
    "Granular Filters": [
      {
        "category": "Warehouse Number",
        "type": "include",
        "values": ["WH-01", "WH-02"]
      }
    ]
  }
}
Field Type Description
Privileges[].Privilege Type string Module name
Privileges[].Privilege Access string None, View, or Edit
Granular Filters array Column-level include/exclude restrictions

Code Examples

curl -b cookies.txt "https://acme.knosc.com/api/role/3"