Listen LabsDocs

    Endpoints

    Search Responses

    Find responses across your workspace by an exact URL parameter value

    GET/api/public/v1/responses
    Request
    curl -X GET 'https://listenlabs.ai/api/public/v1/responses?parameter=<parameter>&value=<value>' \
      -H 'x-api-key: <api_key>'
    Response
    JSON
    {
      "results": [
        {
          "responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "readableResponseId": 0,
          "studyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "linkId": "string",
          "studyUrl": "https://example.com",
          "responseUrl": "https://example.com"
        }
      ],
      "nextCursor": "string"
    }

    Search matches one URL parameter and value in non-deleted studies in your API key's workspace. Hidden responses are excluded unless includeHidden=true.

    Results are newest first. Use nextCursor as cursor to fetch the next page, keeping parameter, value, limit, and includeHidden the same. A null cursor means there are no more results. The default limit is 100; the maximum is 1000.

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Query parameters

    parameterstringrequired
    valuestringrequired
    cursorstring

    nextCursor from the preceding page: unpadded base64url of 1/<UTC timestamp with six fractional digits>/<response UUID>, separated by /. Invalid or unsupported cursors return 400.

    limitinteger

    Default: 100

    includeHiddenboolean

    Default: false

    Responses

    Matching responses

    resultsResponseSearchResult[]required
    nextCursorstring | nullrequired