Skip to main content
GET
/
api
/
public
/
v1
/
studies
/
{study_id}
Get Study
curl --request GET \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_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/studies/{study_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/studies/{study_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/studies/{study_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/studies/{study_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_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>",
  "name": "<string>",
  "study_type": "<string>",
  "recruiting_method": "<string>",
  "language": "<string>",
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "<string>",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true
        }
      ],
      "text_values": [
        "<string>"
      ],
      "disallowed_text_values": [
        "<string>"
      ],
      "category": "<string>"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "total_invites": 123,
  "total_calls": 123,
  "quality_calls": 123
}
{
"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

study_id
string
required

Response

Successful Response

Full study shape returned by get-by-id (includes the heavy fields).

id
string
required
name
string | null
study_type
string | null

Study-type template slug

recruiting_method
string | null

panel or byop

interview_format
enum<string> | null

chat, video, or voice

Available options:
chat,
video,
voice
voice
enum<string> | null

male or female

Available options:
male,
female
language
string | null

Interview language code, e.g. 'en'

byop_config
PublicByopConfigOut · object

Universal interview link for the study

created_at
string<date-time> | null
updated_at
string<date-time> | null
study_plan
PublicStudyPlanOut · object | null

Response variant — all sections optional (a study's stored prompt may not contain every section).

screener_questions
PublicScreenerQuestion · object[] | null
targeting_attributes
PublicTargetingAttribute · object[] | null
total_invites
integer | null
total_calls
integer | null
quality_calls
integer | null

Number of quality interviews