Skip to main content
GET
Get a brand kit

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Path Parameters

id
string
required

Brand kit ID, beginning with brk_. Treat it as an opaque string.

Example:

"brk_01k6c3v7w2q9d8m4n5p6r7s8tx"

Response

The brand kit.

id
string
required

Brand kit ID, beginning with brk_.

object
string
required

Always brand_kit.

workspace_ids
string[]
required

The workspaces that use this kit, among those the key belongs to. Empty for a kit no workspace uses.

A wks_ workspace id. Integer workspace ids are still accepted.

bot
object
required

How the notetaker appears in the call.

email
object
required

How the summary email looks. Only the object named after type is present; the branded options stay stored while type is default.

workspace_id
string | null

The workspace that owns the kit, a wks_ id. null when the key does not belong to it.

preview_url
string<uri>

A page that shows this kit as saved, the notetaker's tile in the call, its chat messages and the summary email. Anyone with the link can open it, without signing in, until preview_expires_at. Every response carries a fresh link.

preview_expires_at
string<date-time>

When preview_url stops working, ten minutes after the response, in ISO 8601. Read the brand kit again for a fresh link.

metadata
object

Your own key-value pairs, for your ids and context. MeetingKit stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See metadata.

Example:
created_at
string<date-time>

When the brand kit was created, in ISO 8601.