YOWO7 API
Workspace Company Profile

GET

/api/v1/workspaces/{workspaceId}/company-profile/brand

Scope workspace:read

Read the workspace brand: legal name, logo and favicon URLs, and brand colors.

Pfad

workspaceIdPflicht
string
Workspace that owns the resource.

Antworten

200WorkspaceBrandSnapshotDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Workspace brand snapshot.

legalName
string
Name of the legal.
hasLogo
boolean
Whether logo is set.
logoUrl
string
URL of the logo.
hasFavicon
boolean
Whether favicon is set.
faviconUrl
string
URL of the favicon.
primaryColorHex
string
Primary color hex.
secondaryColorHex
string
Secondary color hex.
accentColorHex
string
Accent color hex.
accentColorsPflicht
string[]
Accent colors.
additionalBrandColorsPflicht
string[]
Additional brand colors.
400ApiProblemThe request is invalid.
401ApiProblemThe private app token is missing or invalid.
403ApiProblemThe token is missing the required scope, or this action is not allowed.
404ApiProblemThe workspace or resource was not found.
defaultApiProblemError response.