List roles — Brigg developers

Access & visibility

Allow workspace.ListRoles on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Response

Returns 200 OK with a JSON body.

rolesmap of WorkspaceRoleRequired

Workspace role definitions keyed by role identifier. Use the key, not the label, when interpreting a member's role.

Nested fields

labelstringOptional

Human-readable name of this role.

descriptionstringOptional

Descriptive text.

chatOnlybooleanOptional

Whether this role limits the member to chat-based access.

Allowed: false, true.

systembooleanRequired

Whether Brigg supplies this role as a built-in role.

Allowed: false, true.

originstringOptional

Where this role was defined: a bundled app, a custom definition or Brigg itself.

Allowed: "bundle", "custom", "system".

assignablebooleanRequired

Whether this role can be assigned to workspace members.

Allowed: false, true.

memberCountnumberRequired

Number of workspace members assigned to this role.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "roles": {
      "type": "object",
      "description": "Workspace role definitions keyed by role identifier. Use the key, not the label, when interpreting a member's role.",
      "additionalProperties": {
        "title": "WorkspaceRole",
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "Human-readable name of this role."
          },
          "description": {
            "type": "string",
            "description": "Descriptive text."
          },
          "chatOnly": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this role limits the member to chat-based access."
          },
          "system": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether Brigg supplies this role as a built-in role."
          },
          "origin": {
            "type": "string",
            "enum": [
              "bundle",
              "custom",
              "system"
            ],
            "description": "Where this role was defined: a bundled app, a custom definition or Brigg itself."
          },
          "assignable": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether this role can be assigned to workspace members."
          },
          "memberCount": {
            "type": "number",
            "description": "Number of workspace members assigned to this role."
          }
        },
        "required": [
          "system",
          "assignable",
          "memberCount"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "roles"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "roles": {
        "member": {
          "label": "Member",
          "system": true,
          "origin": "system",
          "assignable": true,
          "memberCount": 8
        },
        "admin": {
          "label": "Administrator",
          "system": true,
          "origin": "system",
          "assignable": true,
          "memberCount": 2
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.ListRoles' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListRoles", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListRoles",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.ListRoles' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListRoles", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListRoles",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "roles": {
    "member": {
      "label": "Member",
      "system": true,
      "origin": "system",
      "assignable": true,
      "memberCount": 8
    },
    "admin": {
      "label": "Administrator",
      "system": true,
      "origin": "system",
      "assignable": true,
      "memberCount": 2
    }
  }
}

Illustrative values, not a live response.