Skip to main content
GET
/
api
/
public
/
v1
/
interviews
/
{interview_id}
Get Interview
curl --request GET \
  --url https://api.userintuition.ai/api/public/v1/interviews/{interview_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "study_id": "<string>",
  "participant": {
    "id": "<string>",
    "email": "<string>"
  },
  "status": "<string>",
  "quality": "<string>",
  "end_reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "duration_seconds": 123,
  "messages": [
    {}
  ],
  "audio_recording_url": "<string>",
  "video_recording_url": "<string>",
  "screener_responses": [
    {
      "question": "<string>",
      "type": "<string>",
      "answer": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Path Parameters

​
interview_id
string
required

Response

Successful Response

Full interview shape returned by get-by-id (includes recordings etc.).

​
id
string
required
​
study_id
string | null

The study this interview belongs to

​
participant
PublicInterviewParticipant · object
​
status
string | null
​
quality
string | null

Quality rating: Excellent, Good, Fair, or Poor

​
end_reason
string | null

Why the interview ended

​
started_at
string<date-time> | null

Date and time the interview took place

​
duration_seconds
integer | null

Interview length in seconds (ended_at - started_at)

​
messages
Messages · object[] | null
​
audio_recording_url
string | null
​
video_recording_url
string | null
​
screener_responses
PublicScreenerResponse · object[] | null

The participant's screener answers for this interview.