List members — Brigg developers

Access & visibility

Allow workspace.ListMembers 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.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

itemsarray of Workspace memberRequired

Workspace memberships and invitations; pending distinguishes invitations from joined members. This operation has no cursor pagination.

Item fields

account_idstringRequired

Member's account ID. Use Brigg-Act-As only after the person joins and the key's delegation grant authorizes this active member.

namestringRequired

Member's display name.

emailstring or nullRequired

Member or invitee's email address.

rolestringRequired

Primary workspace role identifier, such as owner, admin or member.

additive_rolesarray of stringRequired

Additional role identifiers contributing permissions alongside the primary role.

joined_atnumberRequired

Membership join time in Unix milliseconds, when available.

pendingbooleanRequired

Whether this is a pending invitation rather than a joined workspace member.

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": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "account_id": {
            "type": "string",
            "description": "Member's account ID. Use Brigg-Act-As only after the person joins and the key's delegation grant authorizes this active member.",
            "examples": [
              "account_alex"
            ]
          },
          "name": {
            "type": "string",
            "description": "Member's display name.",
            "examples": [
              "Alex Morgan"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ],
            "description": "Member or invitee's email address.",
            "examples": [
              "alex@example.com"
            ]
          },
          "role": {
            "type": "string",
            "description": "Primary workspace role identifier, such as owner, admin or member.",
            "examples": [
              "member"
            ]
          },
          "additive_roles": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Additional role identifiers contributing permissions alongside the primary role.",
            "examples": [
              []
            ]
          },
          "joined_at": {
            "type": "number",
            "description": "Membership join time in Unix milliseconds, when available.",
            "examples": [
              1794301200000
            ]
          },
          "pending": {
            "type": "boolean",
            "description": "Whether this is a pending invitation rather than a joined workspace member.",
            "examples": [
              false
            ]
          }
        },
        "required": [
          "account_id",
          "name",
          "email",
          "role",
          "additive_roles",
          "joined_at",
          "pending"
        ],
        "additionalProperties": false,
        "title": "Workspace member"
      },
      "description": "Workspace memberships and invitations; pending distinguishes invitations from joined members. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "account_id": "account_alex",
          "name": "Alex Morgan",
          "email": "alex@example.com",
          "role": "member",
          "additive_roles": [],
          "joined_at": 1794301200000,
          "pending": false
        }
      ]
    }
  ]
}

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.ListMembers' \
  -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.ListMembers", {
  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.ListMembers",
    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.ListMembers' \
  -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.ListMembers", {
  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.ListMembers",
    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

{
  "items": [
    {
      "account_id": "account_alex",
      "name": "Alex Morgan",
      "email": "alex@example.com",
      "role": "member",
      "additive_roles": [],
      "joined_at": 1794301200000,
      "pending": false
    }
  ]
}

Illustrative values, not a live response.