Listen LabsDocs

    Endpoints

    List Studies

    List studies with titles, response counts, creators, and folder paths

    GET/api/public/v1/studies
    Request
    curl -X GET 'https://listenlabs.ai/api/public/v1/studies' \
      -H 'x-api-key: <api_key>'
    Response
    JSON
    [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "title": "string",
        "createdAt": "string",
        "linkId": "string",
        "responseCount": 0,
        "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.

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Responses

    Studies

    idstring<uuid>required
    titlestringrequired
    createdAtstringrequired
    linkIdstringrequired
    responseCountintegerrequired
    creatorStudyCreator | nullrequired
    folderPathstring[] | nullrequired