> 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 voice integration

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

Return a workspace voice integration.

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

## 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 whose voice integration to return.

### Query parameters

- `includeRendered` (boolean, optional) — Include rendered prompt text and first message in the template assignment.

### Headers

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

## Response

### 200

The workspace voice integration.

- `voice` (V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoice, required) — Voice integration settings. Returns \{ connected: false } when no integration is configured. Sensitive credentials are not returned.

## Errors

### 403 Forbidden Error

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

- `message` (string, optional)

### 404 Not Found Error

Workspace not found for this account

- `any`

### 500 Internal Server Error

Internal Server Error

- `any`

## Types

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoice

Voice integration settings. Returns \{ connected: false } when no integration is configured. Sensitive credentials are not returned.

- `connected` (boolean, optional) — Whether a voice assistant is configured on this workspace.
- `promptSource` (enum, optional) — Source of the prompt used for calls: manual or template.
  - Allowed values: `manual`, `template`
- `promptTemplate` (V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoicePromptTemplate, optional, nullable) — Assigned voice prompt template, or null when no template is assigned.
- `firstMessage` (string, optional, nullable) — Greeting spoken first.
- `prompt` (string, optional, nullable) — System prompt used for voice conversations.
- `voice` (V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceVoice, optional, nullable) — The selected text-to-speech voice.
- `fallbackVoices` (list of V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceFallbackVoicesItems, optional) — Ordered fallback voices used if the primary voice fails. Empty when none.
- `transcriber` (V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceTranscriber, optional, nullable) — The selected speech-to-text transcriber.
- `fallbackTranscribers` (list of V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceFallbackTranscribersItems, optional) — Ordered fallback transcribers. Empty when none.
- `phoneNumber` (string, optional, nullable) — Routing number in E.164 format. Forward your business line to this number.

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoicePromptTemplate

Assigned voice prompt template, or null when no template is assigned.

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceVoice

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

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceFallbackVoicesItems

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceTranscriber

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.

### V1WorkspacesWorkspaceIdIntegrationsVoiceGetResponsesContentApplicationJsonSchemaVoiceFallbackTranscribersItems

## Examples

**Response**

```json
{
  "voice": {
    "connected": true,
    "promptSource": "template",
    "promptTemplate": {
      "status": "published",
      "templateId": "a1b2c3d4-5e6f-4a0b-8c1d-2e3f4a5b6c7d",
      "templateName": "Dental clinic receptionist",
      "variables": {
        "company": "Acme Dental"
      },
      "version": 3,
      "versionId": "d4e5f6a7-8091-4c3d-ae4f-5a6b7c8d9e0f"
    },
    "firstMessage": "Hello! How can I help you today?",
    "prompt": "You are a friendly phone assistant…",
    "voice": {
      "provider": "vapi",
      "voiceId": "Clara",
      "model": null
    },
    "fallbackVoices": [],
    "transcriber": {
      "provider": "deepgram",
      "model": "flux-general-en",
      "language": "en"
    },
    "fallbackTranscribers": [],
    "phoneNumber": "+14155551234"
  }
}
```

**SDK Code**

```python
import requests

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

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/integrations/voice';
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/integrations/voice"

	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/integrations/voice")

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/integrations/voice")
  .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/integrations/voice', [
  '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/integrations/voice");
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/integrations/voice")! 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()
```