Get branding — Brigg developers

Access & visibility

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

These are the workspace's branding assets and profile, not a customer's Company record. Asset URLs are public presentation assets; do not upload confidential images as branding.

namestringRequired

Display name.

registered_namestringRequired

Registered legal name of the organization.

domainstring or nullRequired

Website hostname, without a scheme or path.

icon_urlstring or nullRequired

URL of the workspace's configured icon.

logo_urlstring or nullRequired

URL of the workspace's configured logo.

profile_mdstring or nullRequired

Workspace company profile formatted as Markdown.

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": {
    "name": {
      "type": "string",
      "description": "Display name."
    },
    "registered_name": {
      "type": "string",
      "description": "Registered legal name of the organization."
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "Website hostname, without a scheme or path."
    },
    "icon_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL of the workspace's configured icon."
    },
    "logo_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "URL of the workspace's configured logo."
    },
    "profile_md": {
      "type": [
        "string",
        "null"
      ],
      "description": "Workspace company profile formatted as Markdown."
    }
  },
  "required": [
    "name",
    "registered_name",
    "domain",
    "icon_url",
    "logo_url",
    "profile_md"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "name": "Example project",
      "registered_name": "Northstar Consulting AS",
      "domain": null,
      "icon_url": "https://example.com/icon.png",
      "logo_url": "https://example.com/logo.svg",
      "profile_md": "Northstar helps small businesses organize their customer work."
    }
  ]
}

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

{
  "name": "Example project",
  "registered_name": "Northstar Consulting AS",
  "domain": null,
  "icon_url": "https://example.com/icon.png",
  "logo_url": "https://example.com/logo.svg",
  "profile_md": "Northstar helps small businesses organize their customer work."
}

Illustrative values, not a live response.