Skip to main content
GET
List Brand Kit Images

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Path Parameters

brand_kit_id
string
required

Prefixed bk_ wire ID (Crockford base32 body) — the canonical, recommended form. For back-compat, a bare UUID string is also accepted in both path parameters and JSON request bodies (older integrations that stored raw UUIDs keep working). Both are permanent, supported inputs.

Pattern: ^bk_[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
Example:

"bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV"

Response

Successful Response

Brand-kit images list response (ENG-2585).

Returns the full list — brand-kit image counts are small (typical kit has <20 images) so cursor pagination would be over-kill in v1. If a customer hits a real ceiling we can add a cursor without a breaking change. total / returned are carried anyway so the envelope matches the uniform list contract and explicitly says "complete".

data
BrandKitImageResponse · object[]
required

All images attached to the brand kit, logos first then design assets, in insertion order.

returned
integer
default:0

Number of images returned (always len(data)).

total
integer
default:0

True total image count for this brand kit. Always equals returned — this list is complete.