Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Creative Schemas

Filter fields and sort options for both creative feeds. Neither varies by page, by cursor or by caller, so the client fetches this once per session rather than on every page and every filter change.

Cached under one key for everyone. Nothing in the API writes creatives — the sync worker and the metrics batch do — so a newly used subject/topic value appears when the TTL lapses, or immediately via kumquat-cli invalidate-response-cache. Product and user writes drop the key directly, since they supply the id-valued fields’ options.

A tag write drops the key too, for the same reason: tag_slugs offers the Tag Dictionary, so a tag coined on a brief has to be filterable before the TTL lapses.

Deliberately no lock=True, for the reason spelled out on GET /tasks/schema.

GET/api/v1/creatives/schema
Authorization
AuthorizationBearer token · headerrequired
or
AuthorizationOAuth2 access token · headerrequired
Responses
200Successful Response
successboolean
default: true
dataCreativeSchemas | any
Show properties
Any of:
CreativeSchemas
filter_schemaobjectrequired
sort_schemaobjectrequired
any
any
messagestring | any
Show properties
Any of:
string
string
any
any
errorsstring[] | any
Show properties
Any of:
string[]
Array of string
string
any
any
Request
curl -X GET "/api/v1/creatives/schema" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "success": true,
  "data": {
    "filter_schema": {},
    "sort_schema": {}
  },
  "message": "string",
  "errors": [
    "string"
  ]
}