CLI commands
Notes commands
The 1 koast CLI command for the Notes operations.
Every command is one API operation, named by its operationId. Global flags such as --output and --api-url work on all of them, see CLI commands.
list-brand-notes
List brand notes. GET /v1/brands/{brandId}/notes, API reference.
koast list-brand-notes --brand <brand> [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--purpose | string | No | chat-start: the notes a chat loads when it begins (active, not due for review, brand-wide or this ad account; constraints first; at most 20 notes or 6,000 characters). browse: every note, filtered and paged, including notes due for review and retired ones. One of chat-start, browse. Default "browse". |
--kind | string | No | browse only: one kind of note. One of LEARNING, BURNOUT, CONSTRAINT. |
--account-id | string | No | An ad account linked to this brand (for example act_123) when the note is about that account only. Leave it out for a brand-wide note. At most 64 characters. |
--status | string | No | browse only: ACTIVE (default), RETIRED, or ALL. One of ACTIVE, RETIRED, ALL. Default "ACTIVE". |
--include-due | boolean | No | browse only: false to leave out active notes past their review date. Default true. |
--cursor | string | No | Opaque cursor from the previous page's nextCursor. Omit for the first page. |
--limit | integer | No | Page size. Default 50. Minimum 1, maximum 100. |
Required scope: read. Paged. --all follows nextCursor to the end and prints one JSON line per item.
Example:
koast list-brand-notes --brand 123