Skip to main content
GET
List run conversations
Pages through the conversations one run has produced.

Overview

A run mints one conversation per contact it dispatches. This endpoint is the per-contact drill-down behind the aggregate on Get Run: each row is a full conversation resource, in exactly the shape List Conversations returns — status, call attempts, and the analysis or analytics of the call. A run that has not been launched has no conversations yet, and answers with an empty page rather than a 404.
This endpoint needs both read:runs and read:conversations, because its rows are conversation resources rather than a run-shaped summary. read:interviews satisfies the second — see Scopes and Permissions.

Use Cases

  • Drill into a batch: see which contacts were reached and which were not
  • Collect results: read every analysis or analytics object a run produced, one page at a time
  • Triage: find the failed and unreachable contacts to follow up by hand

Basic Usage

With Pagination

limit is capped at 100. See the Pagination Guide for the page object’s fields.

Reading the Results

Each row is the ordinary conversation resource, so everything the conversation endpoints document applies here:
  • status is the conversation’s own status, not the run’s
  • analysis carries the recruiting pipeline’s output, analytics whatever a custom agent’s analyticsConfig asked for. A custom agent typically produces analytics and no analysis
  • runId is this run’s id on every row, which is what lets you attribute a conversation to a run when you receive it any other way
Analysis and analytics are only present once a call has completed and its after-call jobs have run. While the run is dispatching, most rows carry neither.

Company Isolation

You can only read runs belonging to your own API key’s company. A run in another company returns 404 Not Found, the same as one that does not exist.

Error Scenarios

  • 404 Not Found: the run does not exist, has been deleted, or belongs to a different company
  • 403 Forbidden: the API key does not hold both read:runs and read:conversations (read:interviews satisfies the second)

Get Run

The run’s status and aggregate progress

Get Conversation

One conversation in full, with its transcript

Runs Resource Guide

How a run batches conversations

Pagination

How pages work across the API

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: 1 <= x <= 10000
Example:

1

limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

200 - application/json
data
object[]
required

Array of conversations

total
number
required

Total number of items

Example:

150

page
number
required

Current page number

Example:

1

limit
number
required

Number of items per page

Example:

20

totalPages
number
required

Total number of pages

Example:

8