Please Note This method gets roles at the Top Level Community. See  REST API: Get Space Roles  for how to get space roles via the REST API.

Get Roles

GET /api/roles

Get all top level roles. Valid for Communifire version 5.2 and above.

Example Request

GET https://myintranet.communifire.com/api/roles

Example Response

Role JSON object is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":[
        {
            "RoleID":3,
            "UserID":0,
            "SpaceID":0,
            "RoleName":"Member",
            "Description":"Registered members of the website",
            "RoleImageFileName":null
        },
        {
            "RoleID":2,
            "UserID":0,
            "SpaceID":0,
            "RoleName":"Moderator",
            "Description":"Moderator role (default permissions are mostly the same as system administrator)",
            "RoleImageFileName":null
        },
        {
            "RoleID":6,
            "UserID":0,
            "SpaceID":0,
            "RoleName":"Quality Analyst",
            "Description":"Software quality analyst",
            "RoleImageFileName":null
        },
        {
            "RoleID":1,
            "UserID":0,
            "SpaceID":0,
            "RoleName":"SiteAdministrator",
            "Description":"Global Administration role",
            "RoleImageFileName":null
        }
    ]
}

Please Note The content type that you pass in the header of your request should be application/json.