brand-kits

List Brand Kit Images

Changed on Nov 3, 2026

List images attached to a brand kit (ENG-2585).

Returns one row per attached image across logos + design assets so integrators can reconcile state with addBrandKitImage / removeBrandKitImage and avoid duplicate uploads when migrating legacy kits.

Returns 404 not_found if the brand kit does not exist, has been deleted, or the caller lacks team access — the three cases are collapsed so the endpoint does not leak existence of brand kits in other teams.

get/brand-kits/{brand_kit_id}/images

Request

Base URL
https://api.moda.app/v1
URL
https://api.moda.app/v1/brand-kits/{brand_kit_id}/images
Auth
HTTP bearer

Path parameters

brand_kit_idstring 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), as is the prefix over a UUID body (bk_00000000-0000-4000-8000-000000000000). All three are permanent, supported inputs; only the canonical form is ever emitted.

Example:bk_01HT9WK8N3M2J4A5Z6P7Q8R9TV

Headers

Moda-Version'2026-04-12' | '2026-05-01'

Example: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.

Response

Successful Response

returnedinteger

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

totalinteger

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

Example response

{
  "data": [
    {
      "id": "bki_01HT9WK8N3M2J4A5Z6P7Q8R9TV",
      "file_id": "file_01HT9WK8N3M2J4A5Z6P7Q8R9TV"
    }
  ]
}

Changes

Nov 3, 20269ac6a3abc0f8 Revision changes
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history