List apps — Brigg developers

Access & visibility

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

This is the acting member's app-menu catalogue. It excludes surface-owned content such as newsletters and signing documents; use ListBundles for the wider content catalogue. It reports a default view, not every view or an app's API contract.

To call a workspace app, discover its published operations through GET /v1/operations using your credential, or GET /v1/openapi.json for its schema. An app can be visible here without publishing API operations. Never construct an operation name from its label or bundle_id.

itemsarray of Installed appRequired

Installed apps visible to the acting member. This operation has no cursor pagination.

Item fields

bundle_idstringRequired

Installed app ID. This is not its public operation namespace.

kindstringRequired

Content kind such as app, template or document. Use ListBundles when you need surface-owned content rather than menu entries.

labelstringRequired

Human-readable app name; do not treat it as an identifier.

default_viewnull or stringRequired

Initial view chosen when opening the app, or null when no view was selected.

activated_atnumberRequired

Time the app was installed, in Unix milliseconds.

icon_slugnull or stringRequired

Icon name used to display the app, or null when none is configured.

render_modestringRequired

Presentation hint such as runtime, static or email. It is not an authorization level or a public operation namespace.

categorystringRequired

Product category used to organize the app in Brigg.

has_static_routesbooleanRequired

Whether the app defines static website routes; this alone does not make its content publicly accessible.

Allowed: false, true.

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

List bundles

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": {
        "title": "Installed app",
        "type": "object",
        "properties": {
          "bundle_id": {
            "type": "string",
            "description": "Installed app ID. This is not its public operation namespace.",
            "examples": [
              "core"
            ]
          },
          "kind": {
            "type": "string",
            "description": "Content kind such as app, template or document. Use ListBundles when you need surface-owned content rather than menu entries.",
            "examples": [
              "app"
            ]
          },
          "label": {
            "type": "string",
            "description": "Human-readable app name; do not treat it as an identifier.",
            "examples": [
              "Customers"
            ]
          },
          "default_view": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Initial view chosen when opening the app, or null when no view was selected.",
            "examples": [
              null
            ]
          },
          "activated_at": {
            "type": "number",
            "description": "Time the app was installed, in Unix milliseconds.",
            "examples": [
              1794301200000
            ]
          },
          "icon_slug": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Icon name used to display the app, or null when none is configured.",
            "examples": [
              null
            ]
          },
          "render_mode": {
            "type": "string",
            "description": "Presentation hint such as runtime, static or email. It is not an authorization level or a public operation namespace.",
            "examples": [
              "runtime"
            ]
          },
          "category": {
            "type": "string",
            "description": "Product category used to organize the app in Brigg.",
            "examples": [
              "crm"
            ]
          },
          "has_static_routes": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether the app defines static website routes; this alone does not make its content publicly accessible.",
            "examples": [
              false
            ]
          }
        },
        "required": [
          "bundle_id",
          "kind",
          "label",
          "default_view",
          "activated_at",
          "icon_slug",
          "render_mode",
          "category",
          "has_static_routes"
        ],
        "additionalProperties": false
      },
      "description": "Installed apps visible to the acting member. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "bundle_id": "core",
          "kind": "app",
          "label": "Customers",
          "default_view": null,
          "activated_at": 1794301200000,
          "icon_slug": null,
          "render_mode": "runtime",
          "category": "crm",
          "has_static_routes": 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.ListApps' \
  -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.ListApps", {
  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.ListApps",
    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.ListApps' \
  -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.ListApps", {
  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.ListApps",
    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": [
    {
      "bundle_id": "core",
      "kind": "app",
      "label": "Customers",
      "default_view": null,
      "activated_at": 1794301200000,
      "icon_slug": null,
      "render_mode": "runtime",
      "category": "crm",
      "has_static_routes": false
    }
  ]
}

Illustrative values, not a live response.