Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Roles

Get Custom Roles

View the Custom Roles available in a Workspace.

get/v2/team/{team_id}/customroles

Path parameters

team_idnumber required
Example:123

Workspace ID

Query parameters

include_membersboolean
Example:true

Response

Example response

{
  "custom_roles": [
    {
      "id": 4547089,
      "team_id": "301539",
      "name": "guest custom",
      "inherited_role": 4,
      "date_created": "1651189835671",
      "members": [
        12345,
        67899
      ]
    },
    {
      "id": 6715664,
      "team_id": "301539",
      "name": "member custom",
      "inherited_role": 3,
      "date_created": "1651189901020",
      "members": [
        5553,
        98989
      ]
    },
    {
      "id": 2957195,
      "team_id": "301539",
      "name": "admin custom",
      "inherited_role": 2,
      "date_created": "1651189904868",
      "members": [
        47474,
        818181
      ]
    }
  ]
}