Get roles
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Get roles

  • Dark
    Light

GET /teams/roles

Gets the available roles


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.


Sample Response

{
	"result": [
		{
			"id": "64ced5a8-c2b9-4421-821a-4e32bdfaaecc",
			"title": "Contributor",
			"description": "An editor or draft writer with no admin access.",
			"is_system_role": true,
			"is_portal_role": true
		},
		{
			"id": "c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8",
			"title": "Owner",
			"description": "Owner has access to everything.",
			"is_system_role": true,
			"is_portal_role": true
		},
		{
			"id": "264485a9-088e-49bf-b33e-a417e9fa01e5",
			"title": "Admin",
			"description": "Admin has access to everything except billing.",
			"is_system_role": true,
			"is_portal_role": true
		},
		{
			"id": "88ec9ab0-2355-46b6-8eed-b3ce2cd870a8",
			"title": "None",
			"description": "No content scope assigned. This role can be changed later.",
			"is_system_role": true,
			"is_portal_role": false
		},
		{
			"id": "62810dc1-2d21-422e-bdfb-c3daebf91dd3",
			"title": "Editor",
			"description": "The editor can manage the articles, categories, drive, workflows, and content reuse.",
			"is_system_role": true,
			"is_portal_role": false
		},
		{
			"id": "926c7a3c-0fe8-40c8-a96f-f02c95a12d5c",
			"title": "Draft writer",
			"description": "A draft writer can add or edit the articles/category pages but has limitations publishing them.",
			"is_system_role": true,
			"is_portal_role": false
		}
	],
	"extension_data": null,
	"context": null,
	"success": true,
	"errors": [],
	"warnings": [],
	"information": []
}


Response Data

ParameterTypeDescription
idnumberThe ID of the role
titlestringName of the role
descriptionstringDescription of the role
is_system_role
booleanIf true, it indicates that the role is one of the system default roles.
is_portal_role
booleanIf true, it indicates that role is a portal role otherwise it is a content role.

Was this article helpful?

What's Next