Retrieve All Questionnaires – BlueDolphin

This article describes to retrieve all the questionnaires from your repository.

HTTP responses

HTTP response status code	Interpretation
200 OK	Questionnaire retrieved successfully
206 Partial Content	Questionnaires retrieved successfully with limited data
400 Bad Request	Questionnaires could not be retrieved due to invalid tenant data passed

Curl example:

curl --location 'https://publicapi.eu.bluedolphin.app/v1/questionnaires' \
--header 'x-api-key: {apiKey}' \
--header 'tenant: {tenant name}'

Response Properties

Value	Type	Description
total_items	integer	Number of items returned
id	string	ID of the questionnaire
name	string	Name of the questionnaire
target	integer	Type of the questionnaire: 0 - Object questionnaire 1 - Relationship questionnaire

A successful call returns a response with a 200 OK HTTP status code and the following body:

{
 "total_items": 3,
 "questionnaires": [
  {
    "id": "Unique identifier",
    "name": "Questionnaire name",
    "target": 0
  },
  {
    "id": "unique identifier",
    "name": "Questionnaire name"",
    "target": 0
  },
  {
    "id": "Unique identifier",
    "name": "Questionnaire name"",
    "target": 1
  }
 ]
}

HTTP responses

Curl example:

Response Properties

Related articles