Skip to content
API Reference/
/
Get branding

Get branding

Request

Legacy endpoint requiring a JSON request body (not query parameters). Some clients/proxies do not support GET bodies. Prefer reading branding from GET /auth/organization/{organizationId} or its workspace endpoint.

Security
ShuffllApiKey
Bodyapplication/jsonrequired
Any of:
workspaceobjectrequired
organizationobject
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/branding/entity \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "workspace": {
      "id": "string"
    },
    "organization": {
      "id": "string"
    }
  }'

Responses

Successfully retrieved branding.

Bodyapplication/json
companyobject

Company information

isDefaultboolean

Whether using default branding settings

Example:true
enabledboolean

Whether branding is enabled

Example:true
logoWstring

Path to white version of logo

Example:"/files/platform/onboarding/logo-placeholder.svg"
colorsobject

Brand color palette

promptsArray of objects

User's saved prompts with tags and suggestions

aboutstring

Company description used by AI when writing video scripts

Example:"Acme Corp builds innovative solutions for enterprise teams."
videoIdeasArray of objects

AI-generated video idea suggestions for the workspace

videoIdeaStatusstring

Status of the video idea generation

Example:"COMPLETED"
pronunciationsArray of objects

Custom pronunciation settings for brand, people, and product names in AI voiceovers

Response
{
  "isDefault": false,
  "enabled": true,
  "company": {
    "id": "acme-corp",
    "name": "Acme Corp",
    "domain": "acme.com",
    "minSize": null,
    "maxSize": null,
    "geoLocation": null
  },
  "logo": "https://content.shuffll.com/branding/acme-logo.png",
  "logoW": "https://content.shuffll.com/branding/acme-logo-white.png",
  "colors": {
    "colorPrimary": "#1a1a2e",
    "colorSecondary": "#16213e",
    "colorExtra": "#0f3460"
  },
  "about": "Acme Corp builds innovative solutions for enterprise teams.",
  "pronunciations": []
}