Skip to content
/Branding

Branding

Read and update branding configuration (logo, colors, company info, pronunciations) for a workspace or organization.

Operations

Get branding

Request

Retrieve the branding configuration for a workspace or organization.

Pass either workspaceId or organizationId as a query parameter to specify which entity's branding to retrieve.

Security
ShuffllApiKey
Query
workspaceIdstring

ID of the workspace to retrieve branding for

Example:workspaceId=693fb82afd8d1c43077ba0fe
organizationIdstring

ID of the organization to retrieve branding for (used when no workspace is specified)

Example:organizationId=693fb82afd8d1c43077ba0fb
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/branding/entity?workspaceId=693fb82afd8d1c43077ba0fe&organizationId=693fb82afd8d1c43077ba0fb' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

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": []
}