Get all roles

GET

/workspaces-roles

GET

/workspaces-roles

curl https://api.postman.com/workspaces-roles \
     -H "x-api-key: <apiKey>"

{
  "roles": {
    "user": [
      {
        "id": "3",
        "description": "Can manage people and all resources",
        "displayName": "Admin"
      },
      {
        "id": "2",
        "description": "Can create and edit all resources",
        "displayName": "Editor"
      },
      {
        "id": "1",
        "description": "Can view and collaborate on all resources",
        "displayName": "Viewer"
      }
    ],
    "usergroup": [
      {
        "id": "3",
        "description": "Can manage people and all resources",
        "displayName": "Admin"
      },
      {
        "id": "2",
        "description": "Can create and edit all resources",
        "displayName": "Editor"
      },
      {
        "id": "1",
        "description": "Can view and collaborate on all resources",
        "displayName": "Viewer"
      }
    ],
    "partner": [
      {
        "id": "7",
        "description": "Can create and edit workspace resources, and invite partners with Editor or Viewer access to the workspace",
        "displayName": "Editor and Partner Lead"
      },
      {
        "id": "6",
        "description": "Can view, fork and export workspace resources, and invite partners with Viewer access to the workspace",
        "displayName": "Viewer and Partner Lead"
      },
      {
        "id": "5",
        "description": "Can create, edit and fork workspace resources",
        "displayName": "Editor"
      },
      {
        "id": "4",
        "description": "Can send requests and view workspace resources",
        "displayName": "Viewer"
      }
    ]
  }
}

Gets information about all roles in a workspace, based on the team’s plan.

Authentication

x-api-keystring

API Key authentication via header

Response

Successful Response

rolesobjectOptional

Information about the workspace's roles.

Errors

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error