List Studies - Listen Labs

List studies in the API key's organization

curl --request GET \
  --url https://listenlabs.ai/api/public/v1/studies \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://listenlabs.ai/api/public/v1/studies', 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://listenlabs.ai/api/public/v1/studies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://listenlabs.ai/api/public/v1/studies"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://listenlabs.ai/api/public/v1/studies")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "createdAt": "<string>",
    "linkId": "<string>",
    "responseCount": 1,
    "creator": {
      "name": "<string>",
      "email": "<string>"
    },
    "folderPath": [
      "<string>"
    ]
  }
]

GET

api

public

studies

List studies in the API key's organization

curl --request GET \
  --url https://listenlabs.ai/api/public/v1/studies \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://listenlabs.ai/api/public/v1/studies', 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://listenlabs.ai/api/public/v1/studies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$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://listenlabs.ai/api/public/v1/studies"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://listenlabs.ai/api/public/v1/studies")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "createdAt": "<string>",
    "linkId": "<string>",
    "responseCount": 1,
    "creator": {
      "name": "<string>",
      "email": "<string>"
    },
    "folderPath": [
      "<string>"
    ]
  }
]

Study metadata

Each study includes creator and folderPath alongside its identifiers, title, creation time, and completed response count. Both fields are always present but may be null.

creator contains the creator’s name and email. Either nested value may also be null.
folderPath contains the study’s folder path as an array of strings.

Authorizations

x-api-key

string

header

required

Response

Studies

string<uuid>

required

title

string

required

createdAt

string

required

linkId

string

required

responseCount

integer

required

Required range: x >= 0

creator

object | null

required

Show child attributes

folderPath

string[] | null

required

​Study metadata

Authorizations

Response

Study metadata