Skip to main content
GET
/
api
/
public
/
v1
/
studies
/
List Studies
curl --request GET \
  --url https://api.userintuition.ai/api/public/v1/studies/ \
  --header 'Authorization: Bearer <token>'
{
  "studies": [
    {
      "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
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:100
Required range: 1 <= x <= 1000
​
name
string | null

Filter by name

Response

Successful Response

​
studies
PublicStudySummary · object[]
required
​
total_count
integer
required
​
page
integer | null
​
page_size
integer | null