Skip to content

API reference

Logos

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.

The Logo object

The logo object describes an uploaded logo file; the file itself is retrieved separately.

Attributes

  • variantstringRequired

    primary or reversed.

    Possible valuesprimaryreversed

  • contentTypestringRequired

    image/png or image/svg+xml.

    Possible valuesimage/pngimage/svg+xml

  • sizeintegerRequired

    Bytes, at most 2097152.

  • sha256stringRequired

    The file’s SHA-256, in lower-case hex. Also the ETag of the file.

  • updatedAtstring (date-time)Required

    When this logo was last uploaded.

List all logos

PermissionBrand · Read

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).

Returns a list of Logo objects.

Errors

StatusCodeMeaning
401invalid_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).

409api_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”.

501

“Logos aren’t set up on this server.”