Get Workspace

Get details about the workspace associated with the API key

GET /v1/workspace

curl

curl -X GET "https://api.caret.so/v1/workspace" \
     -H "Authorization: Bearer your_api_key_here"

200 OK

{
  "workspace": {
    "id": "ws_123456789",
    "name": "Acme Corp",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z",
    "settings": {
      "keyterms": ["technical", "documentation"],
      "audio_location": "aside-server",
      "meeting_default_permission": "workspace"
    },
    "allowedEmailDomains": ["acme.com"],
    "iconUrl": "https://example.com/icon.png"
  }
}

Overview

This endpoint returns detailed information about the workspace that the provided API key belongs to. It includes basic metadata like the workspace name, creation date, and settings.

Authentication

All API requests must authenticate with Authorization: Bearer <API_KEY>.

Authorization · string · required

Bearer token. Format: Bearer <API_KEY>.

Response

workspace · object

The workspace object.

Show properties

id · string

Unique identifier for the workspace.

name · string

Name of the workspace.

createdAt · string

ISO8601 timestamp when the workspace was created.

updatedAt · string

ISO8601 timestamp when the workspace was last updated.

settings · object

Workspace settings.

Show properties

rag_corpus_id · string

The ID of the RAG corpus associated with the workspace.

company · object

Company information.

Show properties

name · string

Company name.

url · string

Company website URL.

info · string

Company description or information.

headcount · string

Company headcount range.

keyterms · string[]

List of key terms for the workspace.

audio_location · string

Where audio files are stored. One of: none, local, aside-server, custom-server.

purge_period · string

Data retention period in days. One of: NONE, 7, 30, 90, 180, 365.

meeting_default_permission · string

Default permission for new meetings. One of: public, workspace, only-me.

member_meeting_visibility · string

Visibility of member meetings. One of: only-me, workspace-read, workspace-write.

mask_sensitive_info · boolean

Whether to mask sensitive information in transcripts.

auto_public_on_share · boolean

Whether to automatically make meetings public when shared.

allowedEmailDomains · string[] | null

List of allowed email domains for workspace access.

iconUrl · string | null

URL of the workspace icon.

curl

curl -X GET "https://api.caret.so/v1/workspace" \
     -H "Authorization: Bearer your_api_key_here"

200 OK

{
  "workspace": {
    "id": "ws_123456789",
    "name": "Acme Corp",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z",
    "settings": {
      "keyterms": ["technical", "documentation"],
      "audio_location": "aside-server",
      "meeting_default_permission": "workspace"
    },
    "allowedEmailDomains": ["acme.com"],
    "iconUrl": "https://example.com/icon.png"
  }
}