Get user survey responses

GET 
https://us.east1.api.komodowellbeing.com/rest/v1/survey_responses

Get all user survey responses in the current organisation

Request

Query Parameters

limit number
Possible values: >= 1 and <= 500
The number of records.
Default value: 100
cursor number
The ID of the last record viewed. If included, returned results will be starting from the next record ID greater than this value.
Default value: null

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
idnumber
The survey response's ID in Komodo Wellbeing
user_idnumber
The user ID that this response has been made by in Komodo Wellbeing
survey_idnumber
The user survey ID that this response has been made for in Komodo Wellbeing
blueprint_question_idnumber
The survey blueprint question ID that this response has been made for in Komodo Wellbeing
created_atdate-time
When the response was made
scorenumber
The score for this response, which matches a SurveyLibraryScaleAnswer.score value
]
count
has_prev
has_next
cursor

Example (auto)

{
  "data": [
    {
      "id": 0,
      "user_id": 0,
      "survey_id": 0,
      "blueprint_question_id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "score": 0
    }
  ]
}

400

Bad request data

application/json

Schema

Schema

statusnumber
messagestring

Example (auto)

{
  "status": 0,
  "message": "string"
}

401

Invalid authentication

application/json

Schema

Schema

statusnumber
messagestring

Example (auto)

{
  "status": 0,
  "message": "string"
}

404

The specified resource was not found

application/json

Schema

Schema

statusnumber
messagestring

Example (auto)

{
  "status": 0,
  "message": "string"
}

500

Something went wrong processing the request

application/json

Schema

Schema

statusnumber
messagestring

Example (auto)

{
  "status": 0,
  "message": "string"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

name: BearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://us.east1.api.komodowellbeing.com/rest/v1/survey_responses");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
request.Headers.Add("Authorization", "Bearer <x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://us.east1.api.komodowellbeing.com/rest/v1

Auth

ApiKey

Bearer Token

Parameters

limit — query

cursor — query