# Get branding

Read the workspace's display name, registered name, primary domain, logo, icon and company profile.

POST https://api.brigg.app/v1/operations/workspace.GetBranding

## Access & visibility

Allow `workspace.GetBranding` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/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.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Display name. |
| `registered_name` | string | Yes | Registered legal name of the organization. |
| `domain` | string or null | Yes | Website hostname, without a scheme or path. |
| `icon_url` | string or null | Yes | URL of the workspace's configured icon. |
| `logo_url` | string or null | Yes | URL of the workspace's configured logo. |
| `profile_md` | string or null | Yes | 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](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| 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

- [Update branding](https://developer.brigg.app/reference/workspace/UpdateBranding)
- [Refetch brand icon](https://developer.brigg.app/reference/workspace/RefetchBrandIcon)
- [Generate company profile](https://developer.brigg.app/reference/workspace/GenerateCompanyProfile)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

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


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

#### TypeScript


```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


```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
```

#### Response example


```json
{
  "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."
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "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."
    }
  ]
}
```