Surveys API

API Description

In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY by using the VoC authentication API.

The API KEY must be sent in the request authorization header element. If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS

API Endpoints

Environment	Endpoint
Production	`https://api.confidently.fi/api/responses/prod/v2/company/surveys`
Test	`https://api.confidently.fi/api/responses/test/v2/company/surveys`

API response

Element	Description	Type
name	The customer's name	string
companyID	The customer's ID	long
surveys	All surveys under the customer	array
surveyName	Name of the survey	string
surveyId	The survey unique id	long
created	The date when the survey has been created. Example: 2025-12-03T00:00:00.00Z	date time

API request and response example

curl -X GET "https://api.confidently.fi/api/responses/test/v2/company/surveys" -H "Authorization: x-api-key {APIKEY}"

Successful API request returns results in JSON format.

{
  "name": "Confidently International Oy",
  "companyID": 1,
  "surveys": [
    {
      "surveyName": "VoC SMS Survey Demo",
      "surveyId": 3974,
      "created": "2019-02-14T00:21:33.365Z"
    }
  ]
}