> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.lumenia.net/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.lumenia.net/_mcp/server.

# Get workspace

GET https://app.lumenia.net/api/v1/workspaces/{workspaceId}

Return a workspace by ID.

Reference: https://docs.lumenia.net/api-reference/workspaces/get-workspace

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <API_KEY>`, where `API_KEY` is your API key.

## Request

### Path parameters

- `workspaceId` (string, required) — Workspace to retrieve.

### Query parameters

- `includeRendered` (boolean, optional) — Include rendered prompt text and first messages in prompt-template assignments.

### Headers

- `X-Account-Id` (string, required) — Account that owns the workspace.

## Response

### 200

The requested workspace, including configuration and integration status.

- `workspace` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspace, optional)

## Errors

### 403 Forbidden Error

The API key is missing or invalid, or the X-Account-Id does not belong to the API key partner.

- `message` (string, optional)

### 404 Not Found Error

No workspace with this id exists under the account in X-Account-Id.

- `any`

### 500 Internal Server Error

Internal Server Error

- `any`

## Types

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspace

- `id` (string, optional) — The workspace id. This uuid is the sole identifier for the workspace; pass it back as-is in paths.
- `organizationId` (string, optional) — The id of the organization that owns this workspace. This route is addressed by workspace id alone, so this is how you trace a workspace back to its organization.
- `name` (string, optional) — Human-readable workspace name.
- `createdAt` (string, optional) — ISO 8601 timestamp of when the workspace was created.
- `chat` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceChat, optional) — Workspace LLM settings. These apply to text chat and, via the base prompt, to knowledge-base answers including voice knowledge-base responses.
- `knowledgeSearch` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceKnowledgeSearch, optional) — RAG retrieval settings governing how embedded documents are searched. Also applies to voice knowledge-base answers.
- `branding` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceBranding, optional) — Chat-widget appearance.
- `voice` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoice, optional) — Voice (phone) integration status. \{ connected: false } when no voice assistant is set up; the connection fields below are present only when connected is true (promptSource/promptTemplate are always present). Never includes any access or secret token.
- `whatsapp` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceWhatsapp, optional) — WhatsApp integration status. \{ connected: false } when not set up; the fields below are present only when connected is true. Never includes the WhatsApp access token.
- `telegram` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceTelegram, optional) — Telegram integration status. \{ connected: false } when not set up; the fields below are present only when connected is true. Never includes the bot token or webhook secret.
- `counts` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceCounts, optional)

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceChat

Workspace LLM settings. These apply to text chat and, via the base prompt, to knowledge-base answers including voice knowledge-base responses.

- `mode` (enum, optional) — Response mode. chat allows general-knowledge answers when no relevant context is found; query restricts answers to the embedded documents and returns queryRefusalMessage when nothing relevant is found.
  - Allowed values: `chat`, `query`
- `prompt` (string, optional, nullable) — The base system prompt for the workspace. Drives text chat and is the system prompt used to synthesize answers from the knowledge base, including voice knowledge-base responses. null means the built-in default prompt is used.
- `historyLimit` (integer, optional) — Number of previous messages kept as conversation context.
- `temperature` (double, optional, nullable) — LLM sampling temperature. Also governs voice knowledge-base answers. null means the provider default is used.
- `promptSource` (enum, optional) — Which prompt actually runs for text chat: template when a chat prompt template is pinned, manual otherwise.
  - Allowed values: `manual`, `template`
- `promptTemplate` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceChatPromptTemplate, optional, nullable) — The pinned chat prompt template assignment (templateId, templateName, versionId, version, status, variables values; plus renderedPrompt/renderedFirstMessage when ?includeRendered=true). null when the manual prompt is used.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceKnowledgeSearch

RAG retrieval settings governing how embedded documents are searched. Also applies to voice knowledge-base answers.

- `topResults` (integer, optional) — Maximum number of document chunks retrieved per query (top-N).
- `similarityThreshold` (double, optional) — Minimum vector similarity (0 to 1) a chunk must meet to be included; chunks below it are discarded.
- `queryRefusalMessage` (string, optional, nullable) — Message returned in query mode when no relevant context is found. null means the built-in default is used.
- `searchMode` (enum, optional) — Retrieval strategy. Included when reranking is available.
  - Allowed values: `default`, `rerank`

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceBranding

Chat-widget appearance.

- `background` (string, optional) — Background color as a hex string.
- `foreground` (string, optional) — Foreground/text color as a hex string.
- `logo` (string, optional, nullable) — Absolute, publicly fetchable URL of the workspace logo (usable directly as an img src). null when no logo is set or the server public base URL is not configured.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoice

Voice (phone) integration status. \{ connected: false } when no voice assistant is set up; the connection fields below are present only when connected is true (promptSource/promptTemplate are always present). Never includes any access or secret token.

- `connected` (boolean, optional) — Whether a voice assistant is configured on this workspace.
- `promptSource` (enum, optional) — Which prompt runs on voice calls: template when a voice prompt template is pinned (including while connected is still false — the dormant assignment), manual otherwise.
  - Allowed values: `manual`, `template`
- `promptTemplate` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoicePromptTemplate, optional, nullable) — The pinned voice prompt template assignment (same shape as chat.promptTemplate). null when the manual prompt is used.
- `firstMessage` (string, optional, nullable) — The greeting the assistant speaks first.
- `prompt` (string, optional, nullable) — System prompt for the live voice conversation. Distinct from chat.prompt, which governs knowledge-base answers.
- `voice` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceVoice, optional, nullable) — The selected text-to-speech voice.
- `fallbackVoices` (list of V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceFallbackVoicesItems, optional) — Ordered fallback voices used if the primary voice fails.
- `transcriber` (V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceTranscriber, optional, nullable) — The selected speech-to-text transcriber.
- `fallbackTranscribers` (list of V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceFallbackTranscribersItems, optional) — Ordered fallback transcribers.
- `phoneNumber` (string, optional, nullable) — The linked routing phone number in E.164, shown in full (it is a Lumenia-owned destination the customer forwards their line to, not customer PII). null when no number is linked.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceWhatsapp

WhatsApp integration status. \{ connected: false } when not set up; the fields below are present only when connected is true. Never includes the WhatsApp access token.

- `connected` (boolean, optional) — Whether WhatsApp is connected on this workspace.
- `phoneNumberId` (string, optional, nullable) — Meta phone number id.
- `businessAccountId` (string, optional, nullable) — Meta WhatsApp Business Account (WABA) id.
- `businessId` (string, optional, nullable) — Meta business id.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceTelegram

Telegram integration status. \{ connected: false } when not set up; the fields below are present only when connected is true. Never includes the bot token or webhook secret.

- `connected` (boolean, optional) — Whether Telegram is connected on this workspace.
- `botUsername` (string, optional, nullable) — Public bot username.
- `botUserId` (string, optional, nullable) — Telegram bot user id.
- `botUrl` (string, optional, nullable) — Public t.me deep link to the bot; null when the username is unknown.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceCounts

- `embeddedDocuments` (integer, optional) — Number of documents embedded as RAG sources in this workspace.
- `attachedTools` (integer, optional) — Number of org tools enabled on this workspace.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceChatPromptTemplate

The pinned chat prompt template assignment (templateId, templateName, versionId, version, status, variables values; plus renderedPrompt/renderedFirstMessage when ?includeRendered=true). null when the manual prompt is used.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoicePromptTemplate

The pinned voice prompt template assignment (same shape as chat.promptTemplate). null when the manual prompt is used.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceVoice

The selected text-to-speech voice.

- `provider` (string, optional) — TTS provider, e.g. vapi or 11labs.
- `voiceId` (string, optional, nullable) — Provider voice identifier.
- `model` (string, optional, nullable) — TTS model, when the provider requires one (e.g. 11labs). null for providers that do not (e.g. vapi).

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceFallbackVoicesItems

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceTranscriber

The selected speech-to-text transcriber.

- `provider` (string, optional) — STT provider, e.g. deepgram or 11labs.
- `model` (string, optional, nullable) — STT model.
- `language` (string, optional, nullable) — Transcription language code.

### V1WorkspacesWorkspaceIdGetResponsesContentApplicationJsonSchemaWorkspaceVoiceFallbackTranscribersItems

## Examples

**Response**

```json
{
  "workspace": {
    "id": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "organizationId": "3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f",
    "name": "Support",
    "createdAt": "2026-06-15T05:24:00.000Z",
    "chat": {
      "mode": "chat",
      "prompt": "Given the following conversation...",
      "historyLimit": 20,
      "temperature": null
    },
    "knowledgeSearch": {
      "topResults": 4,
      "similarityThreshold": 0.25,
      "queryRefusalMessage": "There is no relevant information in this workspace to answer your query."
    },
    "branding": {
      "background": "#ffd940",
      "foreground": "#1a1a1a",
      "logo": "https://your-host/api/v1/workspaces/9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d/logo?v=2f1c...png"
    },
    "voice": {
      "connected": true,
      "promptSource": "manual",
      "promptTemplate": null,
      "firstMessage": "Hello! How can I help you today?",
      "prompt": "You are a friendly phone assistant. Keep responses concise and helpful.",
      "voice": {
        "provider": "vapi",
        "voiceId": "Clara",
        "model": null
      },
      "fallbackVoices": [],
      "transcriber": {
        "provider": "deepgram",
        "model": "flux-general-en",
        "language": "en"
      },
      "fallbackTranscribers": [],
      "phoneNumber": "+3907751671041"
    },
    "whatsapp": {
      "connected": true,
      "phoneNumberId": "123456789",
      "businessAccountId": "987654321",
      "businessId": "5551234"
    },
    "telegram": {
      "connected": false
    },
    "counts": {
      "embeddedDocuments": 12,
      "attachedTools": 3
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.lumenia.net/api/v1/workspaces/workspaceId"

headers = {
    "X-Account-Id": "X-Account-Id",
    "Authorization": "Bearer <API_KEY>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.lumenia.net/api/v1/workspaces/workspaceId';
const options = {
  method: 'GET',
  headers: {'X-Account-Id': 'X-Account-Id', Authorization: 'Bearer <API_KEY>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.lumenia.net/api/v1/workspaces/workspaceId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Id", "X-Account-Id")
	req.Header.Add("Authorization", "Bearer <API_KEY>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.lumenia.net/api/v1/workspaces/workspaceId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = 'X-Account-Id'
request["Authorization"] = 'Bearer <API_KEY>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.lumenia.net/api/v1/workspaces/workspaceId")
  .header("X-Account-Id", "X-Account-Id")
  .header("Authorization", "Bearer <API_KEY>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.lumenia.net/api/v1/workspaces/workspaceId', [
  'headers' => [
    'Authorization' => 'Bearer <API_KEY>',
    'X-Account-Id' => 'X-Account-Id',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.lumenia.net/api/v1/workspaces/workspaceId");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Account-Id", "X-Account-Id");
request.AddHeader("Authorization", "Bearer <API_KEY>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Account-Id": "X-Account-Id",
  "Authorization": "Bearer <API_KEY>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.lumenia.net/api/v1/workspaces/workspaceId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```