Skip to main content
GET
Retrieve a Request

Authorizations

Authorization
string
header
required

Bearer token obtained from the /v1/auth endpoint

Path Parameters

requestId
string
required

The request ID

Response

Request retrieved successfully. Single-request reads include phone-call enrichment fields (transcript, recordingDownloadUrl, etc.) when a representative call has completed.

requestId
string
requestBatchId
string
schemaId
string
requestType
string
state
enum<string>

Request lifecycle state (uppercase). See State for what each value means and which response fields are populated for it.

Available options:
PROCESSING,
SUCCESS,
PARTIAL,
FAILURE
inputs
object
results
object

Structured request output fields. Empty {} on PROCESSING and FAILURE; partially populated on PARTIAL; fully populated on SUCCESS.

missingFields
string[]

Schema fields the request was unable to obtain. Populated on PARTIAL and FAILURE requests where extraction ran but came up short.

dateCreated
string<date-time> | null

Time the request was created, ISO-8601 with UTC offset (e.g. "2026-04-24T15:30:00.123456+00:00").

completedAt
string<date-time> | null

Time the request reached a terminal state (SUCCESS, PARTIAL, or FAILURE). null while the request is still PROCESSING.

dueDate
string<date-time> | null

Date this request is scheduled to run, as an ISO-8601 timestamp (e.g. "2026-05-08T03:00:00+00:00"). Set at submission time based on your account's daily call capacity and any work already pending. null when no due date is set.

internalId
string | null

Optional. Echoed back from the request body if you supplied one at create time. The key is always present in this response (as null when not supplied), unlike on webhook payloads where the key is omitted entirely.

internalTag
string | null

Optional. Echoed back from the request body if you supplied one at create time. The key is always present in this response (as null when not supplied), unlike on webhook payloads where the key is omitted entirely.

modality
enum<string> | null

How the result was obtained. See Modality for the value semantics. phone_only and digital_plus_phone both mean a phone call was placed (billable at the phone-call rate); digital_only means no phone call.

Available options:
digital_only,
phone_only,
digital_plus_phone
data_completeness
enum<string> | null

Completeness tier of a digital-only result. See data_completeness for current and reserved values.

Available options:
minimum
error
object | null

Structured error details. Populated on FAILURE; null on PROCESSING, SUCCESS, and PARTIAL (a PARTIAL request's primary call effort succeeded, so it has no single failure cause: use missingFields). See error object for the schema and the full errorCode taxonomy.

payerLookup
object

Payer/phone lookup for this request: the same six-field block returned on the POST /v1/requests create response. phoneNumberToUse is the number dialed; phoneNumberSource says where it came from. matched* fields are populated only when SuperDial dialed its own matched number.

to
string

The phone number that was actually dialed, echoed back in sanitized form. Present only once a representative phone call has completed (any terminal state), whether the number was one you supplied or one SuperDial resolved. Use payerLookup.phoneNumberToUse to see the intended number before a call completes.

transcript
string

Full call transcript. Present only when a representative phone call has completed.

transcriptPostCall
string

Optional. Post-call transcript. Present only when a phone call has completed AND your account has post-call transcripts enabled. Contact your account team to turn this on.

recordingDownloadUrl
string

Signed URL for the call recording. Present only when a phone call has completed and a recording exists.

callDuration
string

Call duration in HH:MM:SS format. Present only when a phone call has completed and recording length data exists.

callFromNumber
string

Optional. Outbound caller number (E.164): the line the call originated from. Present only when a phone call has completed AND your account has outbound-number visibility enabled. Contact your account team to turn this on.

callSummary
string

AI-generated call summary. Present only when a representative phone call has completed.

callAuditSummary
string

AI-generated audit summary. Present only when a representative phone call has completed.

contributingCalls
object[] | null

The individual phone calls behind this request's results: one entry per call, in the order they were placed. This is the detailed counterpart to the callSteps summary: each entry carries that one call's transcript, recording, duration, summary, and captured fields, plus a call sequence number and a callStep tying it to the step it belongs to. A request usually completes in one call but can take more (see Calls behind a request). Present only on the single-request read (GET /v1/requests/{requestId}) of a SUCCESS or PARTIAL request fulfilled by at least one phone call, a single-call request included. Omitted when no phone call produced a value (e.g. a digital_only result), and not returned by the list endpoint.

callSteps
object[] | null

The steps SuperDial worked through to complete this request: a summary, one entry per step. Each step gathers one schema's fields and reports its own outcome. A request usually has a single step, but can have more, for example verifying benefits and then checking prior authorization on a separate call (see Calls behind a request). A single step can itself involve more than one call (a redial); numContributingCalls reports how many. This summarizes what was gathered; the captured values live in the top-level results, and the individual calls behind each step are in contributingCalls (tied back by callStep). Present on the single-request read (GET /v1/requests/{requestId}) of a completed phone request in any state: SUCCESS, PARTIAL, or FAILURE; the per-call contributingCalls/resultSources breakdown is added on SUCCESS and PARTIAL. Omitted for digital_only results, and not returned by the list endpoint.

resultSources
object | null

Maps each field in results to the call number (contributingCalls[].call) of the phone call that produced its final value. Useful when a request spanned more than one call and you want to know which call each answer came from. Fields with no phone-call source (e.g. digital_only values) are omitted. Present alongside contributingCalls on the single-request read.