Skip to main content
GET
Get settings

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Path Parameters

id
string
required

Beginning with set_, or happyscribe_defaults for the bottom rung, which is read-only.

Response

The settings.

Values for the fields a partner sets, applied where its assignments say.

id
string

Beginning with set_.

object
string

Always settings.

name
string | null

A name to find the settings by, at most 200 characters; null for none.

recording
object

Whether meetings get recorded, and how.

transcription
object

How the recording is transcribed.

summary
object

How the summary is written.

branding
object

How the notetaker is branded. Only with a workspaces: condition.

assignments
object[]

Where these settings apply. Read-only; change them with the settings assignments endpoints.

created_at
string<date-time>

When the settings were created, in ISO 8601.

updated_at
string<date-time>

When the settings last changed, in ISO 8601.