A logo is a PNG or SVG file uploaded for a brand, as a primary or a reversed version. Runs use whichever stands out more on the artwork. Logos belong to brands.
Returns the site’s logo as an image file (PNG or SVG). The answer carries an ETag (the file’s SHA-256, in quotes) and is cached privately for five minutes; send the ETag back in If-None-Match to get a 304 when nothing changed.
Path parameters
keystringRequired
The document’s key (a brand’s code).
variantstringRequired
Which logo.
Possible valuesprimaryreversed
Returns
The logo.
Errors
Status
Code
Meaning
304
If-None-Match (any of its lines) names the current ETag (weak comparison, or *); no body, with the 200’s ETag, Cache-Control, Content-Security-Policy, X-Content-Type-Options and Vary.
400
“The logo variant must be primary or reversed.”
401
invalid_token
The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.
403
“Your role (<role>) can’t <action>.” (the role is below the route’s minimum) or “Choose an organisation first.” (the session has no organisation).
404
“No logo has been uploaded for that.”
409
api_off
409 with code api_off (“Turn on the API in Developer → API and MCP first.”): an owner hasn’t turned the API on for this organisation, so no API key works yet. An owner turns it on in Settings, then API.
500
“could not read logos” or “could not check token”.
Returns the logos uploaded for a site, the primary one first, then the reversed one. The list is empty when none has been uploaded. Use Retrieve a logo to download one.
Path parameters
keystringRequired
The document’s key (a brand’s code).
Returns
One entry per uploaded variant; [] when none (or no such brand).
The key is missing, unknown, revoked or expired (code invalid_token). Send it as Authorization: Bearer <key>.
403
“Your role (<role>) can’t <action>.” (the role is below the route’s minimum) or “Choose an organisation first.” (the session has no organisation).
409
api_off
409 with code api_off (“Turn on the API in Developer → API and MCP first.”): an owner hasn’t turned the API on for this organisation, so no API key works yet. An owner turns it on in Settings, then API.
500
“could not read logos” or “could not check token”.