List creatives
Browse the active brand's creative library, the images and videos available to put in ads.
Tool name: list-creatives.
Browse the active brand's creative library, the images and videos available to put in ads. Returns a creativeId for each, which is the id addAds, distributeCreative and swapCreatives take. Newest first; filter with search and kind, or pass creativeIds to look up an explicit set. Read-only: listing changes nothing. To add a creative that is not here yet, use uploadCreative.
When to use
Find the creativeId for an image or video before putting it in an ad, or show the user what creatives a brand has. Always call this (or uploadCreative) to obtain a creativeId, never guess one. NOT for the creatives already attached to a launch (use previewAds or getCampaignTree).
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
| Field | Type | Required | Description |
|---|---|---|---|
search | string | No | Filter by creative or file name. Omit to list everything, newest first. At most 200 characters. |
kind | string | No | Narrow to images or to videos. Defaults to ALL. One of ALL, IMAGES, VIDEOS. |
creativeIds | integer[] | No | Look up an explicit set of creative ids instead of browsing. This is also what the gallery sends when a user picks creatives in it, so the ids reach you. At most 60 items. |
page | integer | No | 1-based page. Defaults to 1. Minimum 1. |
limit | integer | No | Creatives per page, 1-100. Defaults to 24. Minimum 1, maximum 100. |
cursor | string | No | Opaque cursor from the previous page's nextCursor. Omit for the first page. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
creatives | object[] | Yes | |
total | integer | Yes | |
page | integer | Yes | |
pages | integer | Yes | |
selection | boolean | Yes | True when the call named explicit creativeIds, i.e. it is a selection rather than a browse. |
nextCursor | string | null | Yes | Pass as cursor to read the next page. Null when there is no next page. |
REST equivalent
GET /v1/brands/{brandId}/creatives, List creatives. CLI: koast list-creatives.