Voice of the Customer


The API returns customer's surveys in JSON format

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 (Please, read how to use API instructions).

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

  • production environment
  • - test environment

API response

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

API request and response example

curl -X GET "" -H "Authorization: x-api-key ABCDEF1234567890"

Successful API request returns results in JSON format.

  "name":"SN4 International Oy",
      "surveyName":"VoC SMS Survey Demo",