Get privacy settings — Brigg developers

Access & visibility

Allow workspace.GetPrivacySettings on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Separate retention, host reminders and attendee notices

These are workspace policies, not the acting member's personal preferences. Any active member can read them; can_manage tells you whether that member is a workspace owner or administrator who may change them. The API key needs the update operation as well as approved delegation to that manager.

The reminder is a private prompt to the host when recording starts. The notice adds disclosure text to eligible future Google/Microsoft invitations with a conference URL and an external attendee that Brigg has permission to update. Changing settings does not prove that every provider invitation has already been updated.

Use the exact values in retention_options when changing retention. A shorter policy can cause existing archived transcripts to expire; immediate deletes verbatim text after its closing summary exists. Saved summaries are separate. A deleted transcript cannot be recovered by selecting a longer policy later.

Response

Returns 200 OK with a JSON body.

retentionstringRequired

Transcript policy: immediate deletes verbatim text once the closing summary exists; hours24 keeps the archive for one day; days30, days90, days180 and days365 retain it for that many days; forever has no automatic expiry. This governs transcripts, not the meeting's saved summary.

ai_disclosure_reminder_enabledbooleanRequired

Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself.

ai_disclosure_reminder_messagestring or nullRequired

Custom host-reminder text, or null to use the localized built-in message.

ai_disclosure_notice_enabledbooleanRequired

Whether Brigg adds the disclosure text to eligible connected-calendar invitations. This is separate from the private host reminder.

ai_disclosure_notice_textstring or nullRequired

Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text.

default_disclosure_messagestringRequired

Built-in host-reminder text in the acting member's language (otherwise the workspace language). Used when the custom reminder is null.

default_disclosure_noticestringRequired

Suggested invitation-disclosure text in the acting member's language. Supply this or your own nonblank text when enabling a previously unset notice.

retention_optionsarray of stringRequired

Exact supported retention IDs. These are policy values, not durations written as 30d or millisecond counts.

can_managebooleanRequired

True for a current workspace owner or administrator. It does not grant the API key permission to call UpdatePrivacySettings.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Update privacy settings

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "retention": {
      "type": "string",
      "description": "Transcript policy: immediate deletes verbatim text once the closing summary exists; hours24 keeps the archive for one day; days30, days90, days180 and days365 retain it for that many days; forever has no automatic expiry. This governs transcripts, not the meeting's saved summary."
    },
    "ai_disclosure_reminder_enabled": {
      "type": "boolean",
      "description": "Whether Brigg reminds the host at recording start to tell attendees that AI is being used. This does not notify attendees itself."
    },
    "ai_disclosure_reminder_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Custom host-reminder text, or null to use the localized built-in message."
    },
    "ai_disclosure_notice_enabled": {
      "type": "boolean",
      "description": "Whether Brigg adds the disclosure text to eligible connected-calendar invitations. This is separate from the private host reminder."
    },
    "ai_disclosure_notice_text": {
      "type": [
        "string",
        "null"
      ],
      "description": "Saved invitation disclosure text, or null when unset. Enabling the notice requires nonblank saved text."
    },
    "default_disclosure_message": {
      "type": "string",
      "description": "Built-in host-reminder text in the acting member's language (otherwise the workspace language). Used when the custom reminder is null."
    },
    "default_disclosure_notice": {
      "type": "string",
      "description": "Suggested invitation-disclosure text in the acting member's language. Supply this or your own nonblank text when enabling a previously unset notice."
    },
    "retention_options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Exact supported retention IDs. These are policy values, not durations written as 30d or millisecond counts."
    },
    "can_manage": {
      "type": "boolean",
      "description": "True for a current workspace owner or administrator. It does not grant the API key permission to call UpdatePrivacySettings."
    }
  },
  "required": [
    "retention",
    "ai_disclosure_reminder_enabled",
    "ai_disclosure_reminder_message",
    "ai_disclosure_notice_enabled",
    "ai_disclosure_notice_text",
    "default_disclosure_message",
    "default_disclosure_notice",
    "retention_options",
    "can_manage"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "retention": "days30",
      "ai_disclosure_reminder_enabled": true,
      "ai_disclosure_reminder_message": null,
      "ai_disclosure_notice_enabled": false,
      "ai_disclosure_notice_text": null,
      "default_disclosure_message": "Remember to let the other meeting attendees know that AI is being used to record and summarize this meeting.",
      "default_disclosure_notice": "Note: AI will be used to transcribe and analyze this meeting.",
      "retention_options": [
        "immediate",
        "hours24",
        "days30",
        "days90",
        "days180",
        "days365",
        "forever"
      ],
      "can_manage": true
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

The custom reminder is unset, so the built-in localized message applies. The invitation notice is off.

Request

cURL

curl 'https://api.brigg.app/v1/operations/workspace.GetPrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/workspace.GetPrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.GetPrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/workspace.GetPrivacySettings' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/workspace.GetPrivacySettings", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.GetPrivacySettings",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "retention": "days30",
  "ai_disclosure_reminder_enabled": true,
  "ai_disclosure_reminder_message": null,
  "ai_disclosure_notice_enabled": false,
  "ai_disclosure_notice_text": null,
  "default_disclosure_message": "Remember to let the other meeting attendees know that AI is being used to record and summarize this meeting.",
  "default_disclosure_notice": "Note: AI will be used to transcribe and analyze this meeting.",
  "retention_options": [
    "immediate",
    "hours24",
    "days30",
    "days90",
    "days180",
    "days365",
    "forever"
  ],
  "can_manage": true
}

Illustrative values, not a live response.