> For a complete page index, fetch https://docs.synthflow.ai/llms.txt. For full documentation content, fetch https://docs.synthflow.ai/llms-full.txt.

# List batch call recipients

GET https://api.synthflow.ai/v2/calls/batch/{batch_call_id}/tasks

Lists every recipient in the batch with its outcome, in the order they were added. Unlike listing calls filtered by `batch_call_id`, this includes recipients that are still queued and recipients that failed before a call was placed, with the reason in `error_message`.

Reference: https://docs.synthflow.ai/api-reference/platform-api/batch-calls/list-batch-call-recipients

## Authentication

- `Authorization` header (bearer token, required)

## Servers

- `https://api.synthflow.ai/v2` (Global, default)
- `https://api.us.synthflow.ai/v2` (United States)
- `https://api.eu.synthflow.ai/v2` (European Union)

## Request

### Path parameters

- `batch_call_id` (string, required)

### Query parameters

- `limit` (integer, optional, default: 20) — Number of recipients per page, between 1 and 100.
- `offset` (integer, optional, default: 0) — Number of recipients to skip.
- `status` (enum, optional) — Only return recipients with this status.
  - Allowed values: `pending`, `claimed`, `dispatched`, `failed`, `canceled`

## Response

### 200

200

- `status` (string, optional)
- `response` (object, optional)
  - `pagination` (object, optional)
    - `total_records` (integer, optional)
    - `limit` (integer, optional)
    - `offset` (integer, optional)
  - `tasks` (list of object, optional)
    - `task_id` (string, optional)
    - `to_phone_number` (string, optional)
    - `lead_name` (string, optional)
    - `lead_email` (string, optional)
    - `status` (string, optional) — One of `pending`, `claimed`, `dispatched`, `failed` or `canceled`.
    - `error_message` (string, optional) — Why the recipient failed. Null unless `status` is `failed`.
    - `call_id` (string, optional) — The call placed for this recipient. Null while the recipient is queued.
    - `created_at` (string, optional)
    - `updated_at` (string, optional)

## Examples

**Response**

```json
{
  "status": "ok",
  "response": {
    "pagination": {
      "total_records": 250,
      "limit": 20,
      "offset": 0
    },
    "tasks": [
      {
        "task_id": "7c3d1f7e-8f7b-4f6e-9a3e-5d2c8b1a4e70",
        "to_phone_number": "+12025551234",
        "lead_name": "John Doe",
        "lead_email": "john.doe@example.com",
        "status": "dispatched",
        "error_message": "string",
        "call_id": "1d9a1c8e-2b7f-4a6d-8c3e-9f5b2d7a1c40",
        "created_at": {},
        "updated_at": {}
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```go
package main

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

func main() {

	url := "https://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks")! 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()
```