Skip to main content
GET
Get Corpus Record

Authorizations

Authorization
string
header
required

Clerk-issued RS256 JWT.

Headers

X-API-Key
string | null

Path Parameters

interview_id
string<uuid>
required
response_id
string<uuid>
required

Query Parameters

expected_record_hash
string | null
Required string length: 64
Pattern: ^[0-9a-fA-F]{64}$

Response

Successful Response

schema_version
string
required
Allowed value: "corpus-record-v1"
campaign_id
string
required
response_id
string
required
status
string
required
is_complete
boolean
required
has_transcript
boolean
required
transcript_revision
integer
required
transcript_turn_count
integer
required
transcript_source
enum<string>
required
Available options:
canonical,
legacy_json,
none
guide_hash
string
required
Pattern: ^[0-9a-fA-F]{64}$
question_mapping_status
enum<string>
required
Available options:
complete,
gaps_present
unmapped_response_turn_indexes
integer[]
required
question_mapping_conflict_turn_indexes
integer[]
required
release_status
enum<string>
required
Available options:
raw_citable,
anonymous_citable,
aggregate_only
privacy_level
string
required
is_anonymous
boolean
required
job_title
string | null
required
department
string | null
required
audience_filter_attributes
Audience Filter Attributes · object
required
metadata_sources
CorpusMetadataSourcesOut · object
required
contact_metadata_source
enum<string> | null
required
Available options:
stored_interview_contact,
linked_person,
mixed
metadata_withheld_reason
string | null
required
participant_metadata_output_allowed
boolean
required
verbatim_output_allowed
boolean
required
output_policy
string
required
started_at
string | null
required
ended_at
string | null
required
duration_minutes
integer | null
required
questions
Questions · object
required
transcript
CorpusTranscriptTurnOut · object[]
required
record_hash
string
required
Pattern: ^[0-9a-fA-F]{64}$