Listen Labs Public API

openapi: 3.2.0
info:
  title: Listen Labs API — Study Data Public API
  version: 1.0.0
  description: 'Retrieve studies, responses, transcripts, and questions from Listen Labs. Authenticate with an `x-api-key` header (contact support@listenlabs.ai to request a key). Each API key is scoped to a single organization.


    Endpoints for creating and launching studies are described in a separate spec: https://docs.listenlabs.ai/api-v2/openapi.yaml


    Full documentation: https://docs.listenlabs.ai'
servers:
- url: https://listenlabs.ai
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Public
paths:
  /api/public/list_surveys:
    get:
      operationId: listStudies
      summary: List Studies
      description: Lists all studies in the API key's organization.
      responses:
        '200':
          description: A list of studies.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Study'
        '401':
          $ref: '#/components/responses/Unauthorized'
      tags:
      - Public
  /api/public/responses/{link_id}:
    get:
      operationId: getResponses
      summary: Get Responses
      description: Lists all responses for a given study.
      parameters:
      - name: link_id
        in: path
        required: true
        description: The link ID of the study. You can find this in the study URL (e.g. in `https://listenlabs.ai/s/abc123` the link ID is `abc123`) or via the List Studies endpoint.
        schema:
          type: string
      - name: page
        in: query
        description: The page number for pagination.
        schema:
          type: integer
          default: 0
      - name: per_page
        in: query
        description: Number of responses to return per page.
        schema:
          type: integer
          default: 1000
      - name: updated_since
        in: query
        description: ISO 8601 date string to filter responses updated after this date (e.g. `2023-08-18T11:51:54.649916Z`).
        schema:
          type: string
          format: date-time
      - name: include_in_progress
        in: query
        description: Whether to include responses whose analysis is still in progress.
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: A list of responses for the given study.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Public
  /api/public/responses/{link_id}/{response_id}:
    get:
      operationId: getSingleResponse
      summary: Get Single Response
      description: Retrieves a single response for a specific study, including the full interview transcript with audio/video links where available.
      parameters:
      - name: link_id
        in: path
        required: true
        description: The link ID of the study.
        schema:
          type: string
      - name: response_id
        in: path
        required: true
        description: The unique ID of the specific response to retrieve.
        schema:
          type: string
      responses:
        '200':
          description: The response with its full transcript.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Public
  /api/public/studies/{study_id}/questions:
    get:
      operationId: getStudyQuestions
      summary: Get Study Questions
      description: Retrieves all questions for a specific study, from the study's latest revision.
      parameters:
      - name: study_id
        in: path
        required: true
        description: The link ID of the study to retrieve questions for. You can find it in the study URL or via the List Studies endpoint.
        schema:
          type: string
      responses:
        '200':
          description: The study's questions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  questions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Question'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Public
  /api/public/v1/studies/create:
    post:
      operationId: createStudy
      summary: Create a study (draft) from a guide
      description: Validates the guide and creates a draft study in the API key's org.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStudyRequest'
      responses:
        '201':
          description: Draft created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
        '400':
          description: 'Invalid JSON, request body, or study guide. Codes: `invalid_json`, `invalid_request_body`, `invalid_study_guide`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                invalidJson:
                  value:
                    error: Invalid JSON body
                    code: invalid_json
                invalidRequestBody:
                  value:
                    error: Invalid request body
                    code: invalid_request_body
                    issues:
                    - code: invalid_type
                      expected: string
                      received: undefined
                      path:
                      - title
                      message: Required
                invalidStudyGuide:
                  value:
                    error: 'Invalid study guide: conditional references unknown item externalId ''q2'''
                    code: invalid_study_guide
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: 'The draft was modified concurrently; retry. Codes: `concurrent_modification`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                concurrentModification:
                  value:
                    error: Study was modified concurrently; please retry
                    code: concurrent_modification
        '500':
          $ref: '#/components/responses/ServerError'
      tags:
      - Public
  /api/public/v1/responses/{linkId}:
    get:
      operationId: listResponses
      summary: List responses for a study
      description: Paginated responses with answers and summaries.
      parameters:
      - name: linkId
        in: path
        required: true
        description: The editable link ID used in the response URL.
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
          minimum: 0
          default: 0
      - name: perPage
        in: query
        schema:
          type: integer
          minimum: 1
          default: 1000
      - name: updatedSince
        in: query
        description: Only responses updated at or after this timestamp.
        schema:
          type: string
          format: date-time
      - name: includeInProgress
        in: query
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: Responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponsesResponse'
        '400':
          description: 'One or more query parameters are invalid. Codes: `bad_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidPage:
                  value:
                    error: page must be an integer of at least 0
                    code: bad_request
                invalidUpdatedSince:
                  value:
                    error: updatedSince must be an ISO 8601 timestamp
                    code: bad_request
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'The study is not in the key''s organization. Codes: `study_not_found`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                studyNotFound:
                  value:
                    error: Study not found
                    code: study_not_found
        '500':
          $ref: '#/components/responses/ServerError'
      tags:
      - Public
  /api/public/v1/responses/{linkId}/{responseId}:
    get:
      operationId: getSingleResponse
      summary: Get one response by UUID or readable ID
      description: Response transcript, URL parameters, and summaries.
      parameters:
      - name: linkId
        in: path
        required: true
        description: The editable link ID used in the response URL.
        schema:
          type: string
      - name: responseId
        in: path
        required: true
        description: Response UUID or positive readable numeric ID.
        schema:
          oneOf:
          - type: string
            format: uuid
          - type: string
            pattern: ^[1-9][0-9]*$
      responses:
        '200':
          description: Response details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSingleResponseResponse'
        '400':
          description: 'The response identifier is invalid. Codes: `bad_request`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalidResponseId:
                  value:
                    error: responseId must be a UUID or a positive readable ID
                    code: bad_request
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'Study or response not found. Codes: `study_not_found`, `response_not_found`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                studyNotFound:
                  value:
                    error: Study not found
                    code: study_not_found
                responseNotFound:
                  value:
                    error: Response not found
                    code: response_not_found
        '500':
          $ref: '#/components/responses/ServerError'
      tags:
      - Public
  /api/public/v1/studies/{studyId}/launch:
    post:
      operationId: launchStudy
      summary: Launch a draft and return the self-recruit link
      description: 'Publishes the draft and opens its self-recruit link. Requires the key''s user to have StartRecruitment on the study. Project responses bill to the launch wallet: pass walletId, or omit the body to auto-select the organization''s wallet when it has exactly one.'
      parameters:
      - name: studyId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LaunchRequest'
      responses:
        '200':
          description: Launched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaunchResponse'
        '400':
          description: 'Invalid body, the organization has multiple wallets and walletId was omitted, or the wallet cannot fund the launch (insufficient balance or grant limit). Codes: `invalid_json`, `invalid_request_body`, `wallet_required`, `insufficient_credits`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              examples:
                invalidJson:
                  value:
                    error: Invalid JSON body
                    code: invalid_json
                invalidRequestBody:
                  value:
                    error: Invalid request body
                    code: invalid_request_body
                    issues:
                    - code: invalid_type
                      expected: string
                      received: number
                      path:
                      - walletId
                      message: Expected string, received number
                walletRequired:
                  value:
                    error: Multiple wallets are available to this organization; pass walletId in the request body (see GET /api/public/v1/wallets)
                    code: wallet_required
                insufficientCredits:
                  value:
                    error: Insufficient balance
                    code: insufficient_credits
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          description: 'No permission to launch this study, or no access to the specified wallet. Codes: `launch_permission_denied`, `wallet_access_denied`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                launchPermissionDenied:
                  value:
                    error: No permission to launch this study
                    code: launch_permission_denied
                walletAccessDenied:
                  value:
                    error: No access to the specified wallet
                    code: wallet_access_denied
        '404':
          description: 'Study not found in the key''s org. Codes: `study_not_found`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                studyNotFound:
                  value:
                    error: Study not found
                    code: study_not_found
        '409':
          description: 'The study is busy (an update is in flight) or the publish raced a concurrent edit. Codes: `study_busy`, `conflict`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                studyBusy:
                  value:
                    error: Study is currently being updated. Try again in a moment.
                    code: study_busy
                publishRace:
                  value:
                    error: Revision is no longer a dev revision. Please refresh and try again.
                    code: conflict
        '500':
          $ref: '#/components/responses/ServerError'
      tags:
      - Public
  /api/public/v1/wallets:
    get:
      operationId: listWallets
      summary: List the organization's wallets with balances
      description: Wallets granted to the API key's organization, each with recruitment and project credit balances. Use a wallet's walletId when launching a study.
      responses:
        '200':
          description: Wallets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '500':
          $ref: '#/components/responses/ServerError'
      tags:
      - Public
components:
  schemas:
    SearchParamCriterion:
      type: object
      properties:
        type:
          type: string
          enum:
          - searchParam
        parameter:
          type: string
          minLength: 1
        value:
          type: string
      required:
      - type
      - parameter
      - value
      additionalProperties: false
    LaunchResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        linkId:
          type: string
        selfRecruitLink:
          type: string
          format: uri
        status:
          type: string
          enum:
          - live
        wallet:
          allOf:
          - $ref: '#/components/schemas/Wallet'
          description: The wallet this launch is billed to. Omitted when no wallet is bound (organization without wallet billing).
      required:
      - id
      - linkId
      - selfRecruitLink
      - status
      additionalProperties: false
    Embed:
      type: object
      properties:
        url:
          type: string
          format: uri
        proxyUrl:
          type: string
          format: uri
      required:
      - url
      additionalProperties: false
    Criterion:
      oneOf:
      - $ref: '#/components/schemas/SelectedTemplateOptionsCriterion'
      - $ref: '#/components/schemas/SearchParamCriterion'
      discriminator:
        propertyName: type
        mapping:
          selectedTemplateOptions: '#/components/schemas/SelectedTemplateOptionsCriterion'
          searchParam: '#/components/schemas/SearchParamCriterion'
    Block:
      type: object
      properties:
        externalId:
          type: string
          minLength: 1
          description: Stable identifier for this block. Auto-generated when omitted. Unique within the payload.
        type:
          type: string
          enum:
          - flat
          - concept
          - screening
        title:
          type: string
        conceptSamplingConfig:
          allOf:
          - $ref: '#/components/schemas/ConceptSamplingConfig'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
          minItems: 1
      required:
      - type
      - title
      - items
      additionalProperties: false
    SingleResponseTranscriptItem:
      type: object
      properties:
        moderator:
          type: string
        user:
          type: string
        audio:
          type:
          - string
          - 'null'
          format: uri
          description: One-hour signed audio URL.
        video:
          allOf:
          - $ref: '#/components/schemas/SingleResponseVideo'
        responseIndex:
          type: integer
          minimum: 0
        discussionGuideQuestionId:
          type:
          - string
          - 'null'
        conceptId:
          type:
          - string
          - 'null'
        isFollowUp:
          type: boolean
        answerId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    GetSingleResponseResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        readableId:
          type: integer
          exclusiveMinimum: 0
        linkId:
          type: string
        urlParams:
          type: object
          additionalProperties:
            type: string
          description: Visible URL parameters.
        tagline:
          type:
          - string
          - 'null'
          description: Generated tagline.
        bulletSummary:
          type: array
          items:
            type: string
          description: Generated summary bullets.
        transcript:
          type: array
          items:
            $ref: '#/components/schemas/SingleResponseTranscriptItem'
      additionalProperties: false
    Media:
      type: object
      properties:
        name:
          type: string
          minLength: 1
        url:
          type: string
          format: uri
        type:
          type: string
          enum:
          - image
          - video
        widthPercentage:
          type: number
        forceWatching:
          type: boolean
      required:
      - name
      - url
      - type
      additionalProperties: false
    ListResponsesResponse:
      type: array
      items:
        $ref: '#/components/schemas/ListResponse'
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable description of the failure.
        code:
          type: string
          enum:
          - invalid_json
          - invalid_request_body
          - invalid_study_guide
          - wallet_required
          - insufficient_credits
          - bad_request
          - missing_api_key
          - invalid_api_key
          - unauthorized
          - launch_permission_denied
          - wallet_access_denied
          - forbidden
          - study_not_found
          - response_not_found
          - not_found
          - study_busy
          - concurrent_modification
          - conflict
          - internal_error
          description: Stable machine-readable error code. Branch on this, not on the `error` text, which may change.
      required:
      - error
      - code
      additionalProperties: false
    MaxDiffItem:
      type: object
      properties:
        externalId:
          type: string
          minLength: 1
          description: Stable identifier for this item. Auto-generated when omitted; set it only when a conditional (questionId) or carryForwardFrom references it. Unique within the payload.
        text:
          type: string
          minLength: 1
        conditional:
          allOf:
          - $ref: '#/components/schemas/Conditional'
        media:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Media'
        embed:
          allOf:
          - $ref: '#/components/schemas/Embed'
        type:
          type: string
          enum:
          - max_diff
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          minItems: 2
          description: The items being compared.
        metric:
          type:
          - string
          - 'null'
        itemsPerScreen:
          anyOf:
          - type: number
            enum:
            - 3
          - type: number
            enum:
            - 4
          - type: number
            enum:
            - 5
      required:
      - text
      - type
      - options
      additionalProperties: false
    Option:
      type: object
      properties:
        externalId:
          type: string
          minLength: 1
          description: Optional handle so a conditional can reference this option by id. Unique within the payload.
        text:
          type: string
          minLength: 1
        status:
          type:
          - string
          - 'null'
          enum:
          - approve
          - reject
          - neutral
          default: null
          description: Required inside screening blocks, null elsewhere.
        exclusiveOption:
          type: boolean
          description: Only valid on the final option of a multi-select multiple_choice question; selecting it clears and locks the other options.
      required:
      - text
      additionalProperties: false
    WalletsResponse:
      type: object
      properties:
        wallets:
          type: array
          items:
            $ref: '#/components/schemas/Wallet'
      required:
      - wallets
      additionalProperties: false
    CreateStudyRequest:
      type: object
      properties:
        title:
          type: string
          minLength: 1
        externalTitle:
          type: string
        background:
          type: string
        studyGoal:
          type: string
        config:
          $ref: '#/components/schemas/Config'
        welcomeMessage:
          $ref: '#/components/schemas/WelcomeMessage'
        closingMessage:
          type: string
        studyGuide:
          type: array
          items:
            $ref: '#/components/schemas/Block'
          minItems: 1
      required:
      - title
      - studyGuide
      additionalProperties: false
      description: 'Rules enforced by the server: at most one screening block and it must be first; screening blocks may contain only multiple_choice items and every option must carry a status; concept blocks require conceptSamplingConfig (>=1 concept) and other blocks must omit it; externalIds must be unique across blocks, items, options, and concepts; conditional questionId and carryForwardFrom must reference the externalId of an earlier item; concept conditionals must reference an item in a block before the concept block.'
    ResponseDetail:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the response.
        survey:
          type: string
          description: The link ID of the survey this response belongs to.
        transcript:
          type: array
          description: A complete transcript of the conversation.
          items:
            $ref: '#/components/schemas/TranscriptRow'
    ConceptSamplingConfig:
      type: object
      properties:
        concepts:
          type: array
          items:
            $ref: '#/components/schemas/Concept_2'
          minItems: 1
        subsampleCount:
          type:
          - integer
          - 'null'
          description: How many concepts each participant sees; null = all.
          exclusiveMinimum: 0
      required:
      - concepts
      additionalProperties: false
    SelectedTemplateOptionsCriterion:
      type: object
      properties:
        type:
          type: string
          enum:
          - selectedTemplateOptions
        questionId:
          type: string
          minLength: 1
          description: externalId of an earlier multiple_choice or matrix item.
        matchingCriteria:
          type: string
          enum:
          - mustSelect
          - mustNotSelect
        choices:
          type: array
          items:
            type: string
          minItems: 1
          description: Option externalIds (falls back to option text). Columns for a matrix source.
        matrixRow:
          type:
          - string
          - 'null'
          description: Required only for a matrix source; the exact row text.
      required:
      - type
      - questionId
      - matchingCriteria
      - choices
      additionalProperties: false
    MatrixItem:
      type: object
      properties:
        externalId:
          type: string
          minLength: 1
          description: Stable identifier for this item. Auto-generated when omitted; set it only when a conditional (questionId) or carryForwardFrom references it. Unique within the payload.
        text:
          type: string
          minLength: 1
        conditional:
          allOf:
          - $ref: '#/components/schemas/Conditional'
        media:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Media'
        embed:
          allOf:
          - $ref: '#/components/schemas/Embed'
        type:
          type: string
          enum:
          - matrix
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          minItems: 1
          description: The columns each row is single-select across.
        rows:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
                minLength: 1
            required:
            - text
            additionalProperties: false
          minItems: 1
      required:
      - text
      - type
      - options
      - rows
      additionalProperties: false
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Human-readable description of the failure.
        code:
          type: string
          enum:
          - invalid_json
          - invalid_request_body
          - invalid_study_guide
          - wallet_required
          - insufficient_credits
          - bad_request
          - missing_api_key
          - invalid_api_key
          - unauthorized
          - launch_permission_denied
          - wallet_access_denied
          - forbidden
          - study_not_found
          - response_not_found
          - not_found
          - study_busy
          - concurrent_modification
          - conflict
          - internal_error
          description: Stable machine-readable error code. Branch on this, not on the `error` text, which may change.
        issues:
          type: array
          items:
            type: object
            additionalProperties: {}
          description: 'Present when code is `invalid_request_body`: the schema violations (Zod issues), each with a `path` and `message`.'
      required:
      - error
      - code
      additionalProperties: false
    ConceptMedia:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Media/properties/name'
        url:
          $ref: '#/components/schemas/Media/properties/url'
        type:
          $ref: '#/components/schemas/Media/properties/type'
        widthPercentage:
          $ref: '#/components/schemas/Media/properties/widthPercentage'
      required:
      - name
      - url
      - type
      additionalProperties: false
    Config:
      type: object
      properties:
        interviewMode:
          type: string
          enum:
          - text
          - audio
          - audio_text
          - audio_screen
          - video
          - video_screen
        questionLanguage:
          type: string
          enum:
          - en
          - en-medical
          - fr
          - de
          - de-CH
          - it
          - pt
          - es
          - zh
          - zh-TW
          - zh-HK
          - af
          - sq
          - am
          - ar
          - hy
          - as
          - ast
          - az
          - ba
          - eu
          - be
          - bn
          - bs
          - br
          - bg
          - my
          - ca
          - ceb
          - ny
          - hr
          - cs
          - da
          - nl
          - et
          - fo
          - fi
          - nl-BE
          - ff
          - gl
          - lg
          - ka
          - el
          - gu
          - ht
          - ha
          - haw
          - he
          - hi
          - hu
          - is
          - ig
          - id
          - ga
          - ja
          - jw
          - kea
          - kn
          - kk
          - km
          - ko
          - ku
          - ky
          - lo
          - la
          - lv
          - ln
          - lt
          - luo
          - lb
          - mk
          - mg
          - ms
          - ml
          - mt
          - mi
          - mr
          - mn
          - ne
          - nso
          - 'no'
          - nn
          - oc
          - or
          - pa
          - ps
          - fa
          - pl
          - ro
          - ru
          - sa
          - sr
          - sn
          - sd
          - si
          - sk
          - sl
          - so
          - su
          - sw
          - sv
          - tl
          - tg
          - ta
          - tt
          - te
          - th
          - bo
          - tr
          - tk
          - uk
          - umb
          - ur
          - uz
          - vi
          - cy
          - wo
          - xh
          - yi
          - yo
          - zu
          description: Language code the questions are written in (e.g. en, de).
        availableLanguages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Config/properties/questionLanguage'
          description: Translation target codes. null/omitted = English only.
        targetPlatforms:
          type: array
          items:
            type: string
            enum:
            - ios
            - android
            - desktop
      additionalProperties: false


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/listen-labs/refs/heads/main/openapi/listen-labs-public-api-openapi.yml