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

# List calls in a time window

GET https://portal.simz.com/api/partner/v1/calls

Returns your company's calls whose start time falls in [from, to), newest first, with cursor pagination. Add `include=transcript` to receive transcripts inline. Each item carries the transcript and recording status so you know what can be fetched.

Reference: https://docs.simz.com/api-reference/sim-z-integration-api/call-export/list-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

### Query parameters

- `from` (datetime, optional) — Inclusive lower bound on the call start time (ISO-8601 UTC). Defaults to `to − 24h`.
- `to` (datetime, optional) — Exclusive upper bound on the call start time (ISO-8601 UTC). Defaults to now. The window may be at most 31 days.
- `limit` (integer, optional, default: 50) — Page size. 1–200 for metadata, 1–100 when `include` contains `transcript`.
- `include` (string, optional) — Comma-separated artifacts to return inline. Allowed values `transcript`, `summary`.
- `status` (string, optional) — Comma-separated call statuses to keep, e.g. `Completed,Transferred`.
- `direction` (enum, optional)
  - Allowed values: `inbound`, `outbound`
- `agent_id` (string, optional) — Restrict to one of your agents.
- `cursor` (string, optional) — Opaque token from the previous page's `pagination.next_cursor`. When present only `limit` may be sent alongside it; the window and filters travel inside the cursor. Cursors expire after 24 hours.

## Response

### 200

A page of calls.

- `success` (boolean, optional)
- `request_id` (string, optional)
- `data` (list of CallItem, optional)
- `pagination` (CursorPagination, 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

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

### CursorPagination

- `limit` (integer, optional)
- `returned` (integer, optional)
- `has_more` (boolean, optional)
- `next_cursor` (string, optional, nullable) — Pass back as `cursor` to fetch the next page. Expires after 24 hours.

### PartnerErrorResponseDetailsItems

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

### CallItemAgent

- `id` (string, optional)
- `name` (string, 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.

### 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`.

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

### 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

**Response**

```json
{
  "success": true,
  "request_id": "string",
  "data": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "returned": 1,
    "has_more": true,
    "next_cursor": "string"
  }
}
```

**SDK Code**

```python
import requests

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

headers = {"X-Company-API-Key": "<apiKey>"}

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

print(response.json())
```

```javascript
const url = 'https://portal.simz.com/api/partner/v1/calls';
const options = {method: 'GET', headers: {'X-Company-API-Key': '<apiKey>'}};

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

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

	req.Header.Add("X-Company-API-Key", "<apiKey>")

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

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

request = Net::HTTP::Get.new(url)
request["X-Company-API-Key"] = '<apiKey>'

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://portal.simz.com/api/partner/v1/calls")
  .header("X-Company-API-Key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://portal.simz.com/api/partner/v1/calls', [
  'headers' => [
    'X-Company-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://portal.simz.com/api/partner/v1/calls");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Company-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Company-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://portal.simz.com/api/partner/v1/calls")! 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()
```