Get team roles
  • 14 Feb 2021
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Get team roles

  • Print
  • Share
  • Dark
    Light

GET/teams/roles

Gets available roles


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > Advanced > API tokens.

Sample Response

{
    "data": [
        {
            "id": 3,
            "role": "DraftWriter",
            "description": "Draft Editor",
            "access_policy": "{\"Payment\":false,\"Settings\":false,\"Publish\":false,\"Write\":true}",
            "hierarchy": 4
        },
        {
            "id": 7,
            "role": "Owner",
            "description": "Project Owner",
            "access_policy": "{\"Payment\":true,\"Settings\":true,\"Publish\":true,\"Write\":true}",
            "hierarchy": 1
        },
        {
            "id": 2,
            "role": "Editor",
            "description": "Editor",
            "access_policy": "{\"Payment\":false,\"Settings\":false,\"Publish\":true,\"Write\":true}",
            "hierarchy": 3
        },
        {
            "id": 1,
            "role": "Admin",
            "description": "Account Owner",
            "access_policy": "{\"Payment\":false,\"Settings\":true,\"Publish\":true,\"Write\":true}",
            "hierarchy": 2
        },
        {
            "id": 4,
            "role": "Reader",
            "description": "Project Reader, user to the user portal/website",
            "access_policy": "{\"Payment\":false,\"Settings\":false,\"Publish\":false,\"Write\":false}",
            "hierarchy": 5
        }
    ],
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Data

Parameter Type Description
id number ID of the role
role string Name of the role
description string Description of the role
access_policy jsonstring Stringified json representing access restrictions for the role
hierarchy number Numbered representation of role hierarchy 1 - highest / 5 - lowest
Was This Article Helpful?