Skip to main content
GET
Get retrieval request

Authorizations

Authorization
string
header
required

API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...

Path Parameters

retrieval_request_id
string
required

Retrieval request ID

Response

Successful response

id
string
required

Unique retrieval request identifier

Example:

"rr_abc123"

order_number
string | null
required

Human-readable order number, or null when unavailable.

Example:

"T-ABC-12345"

case_id
string | null
required

Associated case ID

Example:

"case_abc123"

status
enum<string>
required

Coarse public retrieval status. completed and cancelled are terminal. A non-terminal request with an unanswered action request (a timeline action_request with status awaiting_response) is always action_required.

Available options:
received,
processing,
action_required,
completed,
cancelled
Example:

"processing"

stage
enum<string>
required

Lifecycle stage shown on the Tavrn platform dashboard.

Available options:
submitted,
locating_contact,
contact_found,
request_sent,
confirming_receipt,
acknowledged,
invoice_received,
action_required,
completed,
cancelled
Example:

"acknowledged"

stage_label
string
required

Human-readable label for stage, as shown on the Tavrn platform dashboard

Example:

"Request Acknowledged"

patient
object
required

Patient fields returned by retrieval GET and list responses.

facility
object
required

Facility fields returned by retrieval GET and list responses. Name and address fields may be null, and phone or fax may be omitted.

documents_summary
object
required

Counts records and provider invoices; excludes cost summaries.

created_at
string<date-time>
required
Example:

"2025-02-01T12:50:00Z"

updated_at
string<date-time>
required
Example:

"2025-02-03T09:14:21Z"

public_updated_at
string<date-time> | null
required

Timestamp for public request changes, including status, action requests, and documents. Costs may change without advancing it. Use the final list checkpoint, not this field, for incremental polling. May be null.

Example:

"2026-10-08T12:00:00.000Z"

requested_records
object[]
required

The record lines that were requested from the facility

requestor_id
string | null
required

Selected Requestor profile ID. A null read value uses the default profile. Omitting Requestor fields on creation also uses the default.

Pattern: ^[a-fA-F0-9]{24}$
Example:

"111111111111111111111111"

costs
object
required

Current request costs, returned by the get endpoint only. Amounts are in USD, not cents. Costs can change after completion without advancing public_updated_at or producing a webhook; fetch the request again when you need current costs. A documents_available event is sent when a provider invoice becomes downloadable.

platform_url
string | null

Deep link to this retrieval request on the Tavrn platform dashboard; null when the request has no linked case

Example:

"https://platform.tavrn.ai/cases/case_abc123?section=workflows%2Fretrieval-manager&view=detail&orderId=rr_abc123"

action_required_reason
enum<string> | null

Sub-reason when status is action_required; null otherwise

Available options:
payment_needed,
contact_missing,
request_issue,
other
Example:

null

stage_description
string | null

Plain-language sentence for the current stage, as shown on the Tavrn platform dashboard. Null when there is nothing to show yet.

Example:

"Your request is in progress with the provider. We follow up with them regularly and will post updates here."

timeline
object[]

Ordered lifecycle of the request as rendered on the Tavrn platform dashboard. The standard steps (submitted, locating_contact, contact_found, request_sent, confirming_receipt, acknowledged, completed) always appear, each with a state of completed, current, pending or skipped. Conditional stages (invoice_received, action_required, cancelled) appear only when they occurred, so a stage may be absent, and action_required repeats once per action request. Returned by GET and by list with include=details; omitted from summary list results.

pending_action_request
object | null

The open action request your firm needs to answer with Respond to action request; null when there is none. Returned by the get endpoint and list with include=details.

service_start_date
string<date> | null
Example:

"2024-03-15"

service_end_date
string<date> | null
Example:

"2024-09-30"

notes
string | null
Example:

null

documents
object[]

Available retrieval documents, including cost_summary for completed requests with finalized billing. Returned by GET and list results with include=details.

completed_at
string<date-time> | null

Completion timestamp (null until terminal)

Example:

null