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

# Retrieve transcripts for specific calls

POST https://portal.simz.com/api/partner/v1/calls/retrieve
Content-Type: application/json

Returns transcripts (and optionally AI summaries) for up to 100 call IDs. Always 200 when the request is valid; each ID gets its own result. `not_found` means the ID is not in your company — unknown IDs and other customers' IDs are indistinguishable.

Reference: https://docs.simz.com/api-reference/sim-z-integration-api/call-export/retrieve-calls

## Authentication

- `X-Company-API-Key` header (required) — Company API key with the calls:read scope, created in the SimZ portal under API Access.

## Request

### Body (application/json)

This endpoint expects a RetrieveCallsRequest.

- `call_ids` (list of string, required) — 1–100 call IDs; duplicates are removed.
- `include` (list of enum, optional) — Defaults to `["transcript"]`.
  - Allowed values: `transcript`, `summary`

## Response

### 200

Per-call results.

- `success` (boolean, optional)
- `request_id` (string, optional)
- `data` (RetrieveCallsResponseData, optional)

## Errors

### 400 Bad Request Error

Invalid parameter or body (`VALIDATION_ERROR`, with `details`), or an invalid / expired / mis-combined cursor (`INVALID_CURSOR`).

- `success` (boolean, optional)
- `error` (string, optional)
- `code` (string, optional) — `VALIDATION_ERROR`, `INVALID_CURSOR`, `AUTH_FAILED`, `KEY_EXPIRED`, `SCOPE_DENIED`, `FEATURE_DISABLED`, `NOT_FOUND`, `RECORDING_NOT_AVAILABLE`, `PAYLOAD_TOO_LARGE`, `RANGE_NOT_SATISFIABLE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `DEPENDENCY_UNAVAILABLE`.
- `details` (list of PartnerErrorResponseDetailsItems, optional) — Present on `VALIDATION_ERROR`.
- `request_id` (string, optional)

### 401 Unauthorized Error

Missing, unknown or revoked key (`AUTH_FAILED`), or expired key (`KEY_EXPIRED`).

- `success` (boolean, optional)
- `error` (string, optional)
- `code` (string, optional) — `VALIDATION_ERROR`, `INVALID_CURSOR`, `AUTH_FAILED`, `KEY_EXPIRED`, `SCOPE_DENIED`, `FEATURE_DISABLED`, `NOT_FOUND`, `RECORDING_NOT_AVAILABLE`, `PAYLOAD_TOO_LARGE`, `RANGE_NOT_SATISFIABLE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `DEPENDENCY_UNAVAILABLE`.
- `details` (list of PartnerErrorResponseDetailsItems, optional) — Present on `VALIDATION_ERROR`.
- `request_id` (string, optional)

### 403 Forbidden Error

Key lacks the `calls:read` scope (`SCOPE_DENIED`) or the Call Export API is not enabled for the company (`FEATURE_DISABLED`).

- `success` (boolean, optional)
- `error` (string, optional)
- `code` (string, optional) — `VALIDATION_ERROR`, `INVALID_CURSOR`, `AUTH_FAILED`, `KEY_EXPIRED`, `SCOPE_DENIED`, `FEATURE_DISABLED`, `NOT_FOUND`, `RECORDING_NOT_AVAILABLE`, `PAYLOAD_TOO_LARGE`, `RANGE_NOT_SATISFIABLE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `DEPENDENCY_UNAVAILABLE`.
- `details` (list of PartnerErrorResponseDetailsItems, optional) — Present on `VALIDATION_ERROR`.
- `request_id` (string, optional)

### 429 Too Many Requests Error

Per-key limit exceeded (list 60/min, retrieve 30/min, recording 120/min). Wait `Retry-After` seconds.

- `success` (boolean, optional)
- `error` (string, optional)
- `code` (string, optional) — `VALIDATION_ERROR`, `INVALID_CURSOR`, `AUTH_FAILED`, `KEY_EXPIRED`, `SCOPE_DENIED`, `FEATURE_DISABLED`, `NOT_FOUND`, `RECORDING_NOT_AVAILABLE`, `PAYLOAD_TOO_LARGE`, `RANGE_NOT_SATISFIABLE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `DEPENDENCY_UNAVAILABLE`.
- `details` (list of PartnerErrorResponseDetailsItems, optional) — Present on `VALIDATION_ERROR`.
- `request_id` (string, optional)

### 503 Service Unavailable Error

A SimZ dependency is temporarily unavailable; retry with exponential backoff.

- `success` (boolean, optional)
- `error` (string, optional)
- `code` (string, optional) — `VALIDATION_ERROR`, `INVALID_CURSOR`, `AUTH_FAILED`, `KEY_EXPIRED`, `SCOPE_DENIED`, `FEATURE_DISABLED`, `NOT_FOUND`, `RECORDING_NOT_AVAILABLE`, `PAYLOAD_TOO_LARGE`, `RANGE_NOT_SATISFIABLE`, `RATE_LIMITED`, `INTERNAL_ERROR`, `DEPENDENCY_UNAVAILABLE`.
- `details` (list of PartnerErrorResponseDetailsItems, optional) — Present on `VALIDATION_ERROR`.
- `request_id` (string, optional)

## Types

### RetrieveCallsResponseData

- `requested` (integer, optional)
- `found` (integer, optional)
- `not_found` (integer, optional)
- `items` (list of RetrieveCallItem, optional)

### PartnerErrorResponseDetailsItems

- `field` (string, optional)
- `message` (string, optional)

### RetrieveCallItem

- `call_id` (string, optional)
- `status` (enum, optional)
  - Allowed values: `found`, `not_found`
- `call` (CallItem, optional)
- `transcript` (Transcript, optional) — Status only unless `include=transcript` was requested and the transcript is available.
- `summary` (Summary, optional)

### CallItem

- `call_id` (string, optional)
- `started_at` (datetime, optional)
- `ended_at` (datetime, optional, nullable) — `null` while the call is in progress.
- `duration_seconds` (integer, optional, nullable)
- `direction` (enum, optional)
  - Allowed values: `inbound`, `outbound`
- `status` (string, optional) — SimZ call status, e.g. `Completed`, `Transferred`, `No Answer`, `Voicemail`.
- `end_reason` (string, optional, nullable)
- `from_number` (string, optional, nullable)
- `to_number` (string, optional, nullable)
- `client_name` (string, optional, nullable)
- `agent` (CallItemAgent, optional, nullable)
- `campaign` (string, optional, nullable)
- `amd_result` (string, optional, nullable)
- `transcript` (Transcript, optional) — Status only unless `include=transcript` was requested and the transcript is available.
- `recording` (Recording, optional)
- `summary` (Summary, optional, nullable)

### Transcript

Status only unless `include=transcript` was requested and the transcript is available.

- `status` (enum, optional) — `available` ready · `processing` call in progress or still being finalised/transcribed · `not_available` never produced (see `reason`) · `failed` processing failed · `expired` past retention (recordings 90 days, transcripts 180 days) · `unavailable` temporary outage.
  - Allowed values: `available`, `processing`, `not_available`, `failed`, `expired`, `unavailable`
- `reason` (string, optional) — Present for `not_available`, `failed`, `expired`, `unavailable`.
- `format` (enum, optional)
  - Allowed values: `segments`
- `segments` (list of TranscriptSegment, optional)
- `text` (string, optional) — Whole conversation flattened as `SPEAKER: text` lines.

### Summary

- `status` (enum, optional) — `available` ready · `processing` call in progress or still being finalised/transcribed · `not_available` never produced (see `reason`) · `failed` processing failed · `expired` past retention (recordings 90 days, transcripts 180 days) · `unavailable` temporary outage.
  - Allowed values: `available`, `processing`, `not_available`, `failed`, `expired`, `unavailable`
- `text` (string, optional)

### CallItemAgent

- `id` (string, optional)
- `name` (string, optional, nullable)

### Recording

- `status` (enum, optional) — `available` ready · `processing` call in progress or still being finalised/transcribed · `not_available` never produced (see `reason`) · `failed` processing failed · `expired` past retention (recordings 90 days, transcripts 180 days) · `unavailable` temporary outage.
  - Allowed values: `available`, `processing`, `not_available`, `failed`, `expired`, `unavailable`
- `reason` (string, optional)
- `encryption` (enum, optional)
  - Allowed values: `none`
- `content_type` (string, optional)
- `path` (string, optional) — Download path relative to the API host; present only when `status` is `available`.

### TranscriptSegment

- `speaker` (enum, optional) — `agent` (SimZ voice AI), `user` (caller or callee), `operator` (human who joined).
  - Allowed values: `agent`, `user`, `operator`
- `text` (string, optional)
- `timestamp` (datetime, optional)
- `offset_ms` (integer, optional, nullable) — Milliseconds from the start of the recording.
- `complete` (boolean, optional) — `false` when the utterance was interrupted.

## Examples

**Request**

```json
{
  "call_ids": [
    "string"
  ]
}
```

**Response**

```json
{
  "success": true,
  "request_id": "string",
  "data": {
    "requested": 1,
    "found": 1,
    "not_found": 1,
    "items": [
      {
        "call_id": "string",
        "status": "found",
        "call": {
          "call_id": "string",
          "started_at": "2024-01-15T09:30:00Z",
          "ended_at": "2024-01-15T09:30:00Z",
          "duration_seconds": 1,
          "direction": "inbound",
          "status": "string",
          "end_reason": "string",
          "from_number": "string",
          "to_number": "string",
          "client_name": "string",
          "agent": {
            "id": "string",
            "name": "string"
          },
          "campaign": "string",
          "amd_result": "string",
          "transcript": {
            "status": "available",
            "reason": "string",
            "format": "segments",
            "segments": [
              {
                "speaker": "agent",
                "text": "string",
                "timestamp": "2024-01-15T09:30:00Z",
                "offset_ms": 1,
                "complete": true
              }
            ],
            "text": "string"
          },
          "recording": {
            "status": "available",
            "reason": "string",
            "encryption": "none",
            "content_type": "audio/mpeg",
            "path": "/api/partner/v1/calls/call_1762561234567_ab12cd/recording"
          },
          "summary": {
            "status": "available",
            "text": "string"
          }
        },
        "transcript": {
          "status": "available",
          "reason": "string",
          "format": "segments",
          "segments": [
            {
              "speaker": "agent",
              "text": "string",
              "timestamp": "2024-01-15T09:30:00Z",
              "offset_ms": 1,
              "complete": true
            }
          ],
          "text": "string"
        },
        "summary": {
          "status": "available",
          "text": "string"
        }
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://portal.simz.com/api/partner/v1/calls/retrieve"

payload = { "call_ids": ["string"] }
headers = {
    "X-Company-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://portal.simz.com/api/partner/v1/calls/retrieve';
const options = {
  method: 'POST',
  headers: {'X-Company-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"call_ids":["string"]}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://portal.simz.com/api/partner/v1/calls/retrieve"

	payload := strings.NewReader("{\n  \"call_ids\": [\n    \"string\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Company-API-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	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://portal.simz.com/api/partner/v1/calls/retrieve")

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

request = Net::HTTP::Post.new(url)
request["X-Company-API-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"call_ids\": [\n    \"string\"\n  ]\n}"

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.post("https://portal.simz.com/api/partner/v1/calls/retrieve")
  .header("X-Company-API-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_ids\": [\n    \"string\"\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://portal.simz.com/api/partner/v1/calls/retrieve', [
  'body' => '{
  "call_ids": [
    "string"
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Company-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://portal.simz.com/api/partner/v1/calls/retrieve");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Company-API-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"call_ids\": [\n    \"string\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Company-API-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["call_ids": ["string"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://portal.simz.com/api/partner/v1/calls/retrieve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```