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>'
import requests

url = "https://api.userintuition.ai/api/public/v1/interviews/{interview_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userintuition.ai/api/public/v1/interviews/{interview_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.userintuition.ai/api/public/v1/interviews/{interview_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.userintuition.ai/api/public/v1/interviews/{interview_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.userintuition.ai/api/public/v1/interviews/{interview_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/interviews/{interview_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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>"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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 | null

null for panel (anonymous) interviews

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.