Read the Organization's Compliance profile

GET /v1/compliance-profile

Answers the version of the caller's Organization's Compliance profile in force, whose number is also the ETag (1.32.0, workspace ADR 0082). Before the owner first changes it, the answer is version 0, the defaults: recording with the announcement, Providers in us only, no BAA required and no fallback from the Organization's own key to Vocal's. Every Member role holds organization:read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the organization:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/compliance-profile" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/compliance-profile`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/compliance-profile",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Responses

Fields of the 200 answer

The shape is ComplianceProfile.