Skip to main content
GET
/
v1
/
workspace

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

{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.caret.so/llms.txt

Use this file to discover all available pages before exploring further.

​
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.

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

{
  "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"
  }
}