HAhappyscribe
Brand kits

List brand kits

The brand kits used by at least one workspace the key belongs to, oldest first. Kits created in the dashboard are listed too and get a brk_ id the first time they are read.

get/brand_kits

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Query parameters

workspace_idstring
Example:wks_01k6a2r9s8x7c2dvq3m5n6p4ab

Only the brand kit this workspace uses. A wks_ id; integer workspace ids are still accepted.

limitinteger

Page size, 1 to 100.

cursorstring

Opaque. Follow _links.next.url rather than building it.

Response

One page of brand kits.

objectstring

Always list.

has_moreboolean

Whether more results follow this page.

Example response

{
  "data": [
    {
      "id": "brk_01k6c3v7w2q9d8m4n5p6r7s8tx",
      "object": "brand_kit",
      "workspace_ids": [
        "wks_01k6a2r9s8x7c2dvq3m5n6p4ab",
        "wks_01k6a3t4v5w6x7y8z9a0b1c2de"
      ],
      "bot_name": "Acme Assistant",
      "background_color": "#2E2E2E",
      "brand_color": "#0052FF",
      "brand_url": "https://acme.com/app",
      "brand_description": "Acme AI Meeting Companion",
      "logo_url": "https://assets.happyscribe.com/logos/acme.png",
      "logo_scale": 80,
      "custom_thumbnail_url": null,
      "show_video": true,
      "send_chat_message": true,
      "chat_message": "Hi everyone! I am taking notes for {{user}}.",
      "chat_message_paused": "Recording is currently paused.",
      "preview_url": "https://www.happyscribe.com/app/shared/brand-kits/brk_01k6c3v7w2q9d8m4n5p6r7s8tx/preview?token=WyJicmtfMDFrNmMzdjd3MnE5ZDhtNG41cDZyN3M4dHgiLDE3OTA0MTM4MDBd--50d858e0985ecc7f60418aaf0cc5ab587f42c2570a884095a9e8ccacd0f6545c",
      "preview_expires_at": "2026-09-26T09:10:00Z",
      "metadata": {},
      "created_at": "2026-09-26T09:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.