Download OpenAPI specification:Download
To authenticate with our API you need to provide following HTTP header field in every request:
X-EchonovumAPI-Key: Your API Key
API keys can be created in the ECHONOVUM HUB. Refer to an owner of your organization to obtain one.
Our API currently supports JSON API standard. Make sure to specify application/vnd.api+json
as the Content-Type
in your requests:
Content-Type: application/vnd.api+json
Collection resources are paginated. The pagination follows the JSON API standard. Specify the page
query parameter to loop through the pages.
Example: /en/v1/profiles?page=5
locale required | string Example: en Request locale |
page | integer Example: page=1 Page number |
Profile collection response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profiles
{- "meta": {
- "totalItems": 2379,
- "itemsPerPage": 30,
- "currentPage": 1
}, - "links": {
- "self": "/en/v1/{type}",
- "first": "/en/v1/{type}?page=1",
- "last": "/en/v1/{type}?page=80",
- "next": "/en/v1/{type}?page=2"
}, - "data": [
- {
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b",
- "type": "ProfileV1",
- "attributes": {
- "uuid": "86a8a563-93c6-5ee0-8925-45d32e02490b",
- "allowMultisurvey": true,
- "identifier": "id",
- "name": "full name",
- "attributes": {
- "id": "A156BT",
- "full name": "John Doe",
- "age": "45"
}, - "accessCodes": {
- "subject": "02qit0",
- "object": "03KGSw"
}
}
}
]
}
locale required | string Example: en Request locale |
data required | object |
Profile creation response
Bad request response
Unprocessable entity response
{- "data": {
- "type": "ProfileV1",
- "attributes": {
- "profile": {
- "id": "A156BT",
- "full name": "John Doe",
- "age": "45"
}, - "settings": {
- "identifier": "id",
- "name": "full name",
- "allowMultisurvey": false
}
}
}
}
locale required | string Example: en Request locale |
data required | object |
Profile creation response
Bad request response
{- "data": {
- "type": "ProfileV1",
- "attributes": {
- "profile": {
- "id": "A156BT",
- "full name": "John Doe",
- "age": "45"
}, - "settings": {
- "identifier": "id",
- "name": "full name",
- "allowMultisurvey": false
}
}
}
}
locale required | string Example: en Request locale |
uuid required | string Example: 57b897f8-53fa-11ea-b2a4-0242ac120006 |
Profile item response
Profile not found response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profiles/57b897f8-53fa-11ea-b2a4-0242ac120006
{- "data": {
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b",
- "type": "ProfileV1",
- "attributes": {
- "uuid": "86a8a563-93c6-5ee0-8925-45d32e02490b",
- "allowMultisurvey": true,
- "identifier": "id",
- "name": "full name",
- "attributes": {
- "id": "A156BT",
- "full name": "John Doe",
- "age": "45"
}, - "accessCodes": {
- "subject": "02qit0",
- "object": "03KGSw"
}
}
}
}
locale required | string Example: en Request locale |
uuid required | string Example: 57b897f8-53fa-11ea-b2a4-0242ac120006 |
Profile deletion response
Profile not found response
curl -X DELETE \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profiles/57b897f8-53fa-11ea-b2a4-0242ac120006
locale required | string Example: en Request locale |
identifierName required | string |
identifierValue required | string |
Profile item response
Profile not found response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profiles/id/value/A156BT
{- "data": {
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b",
- "type": "ProfileV1",
- "attributes": {
- "uuid": "86a8a563-93c6-5ee0-8925-45d32e02490b",
- "allowMultisurvey": true,
- "identifier": "id",
- "name": "full name",
- "attributes": {
- "id": "A156BT",
- "full name": "John Doe",
- "age": "45"
}, - "accessCodes": {
- "subject": "02qit0",
- "object": "03KGSw"
}
}
}
}
locale required | string Example: en Request locale |
page | integer Example: page=1 Page number |
ProfileSchema collection response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profile-schemas
{- "meta": {
- "totalItems": 2379,
- "itemsPerPage": 30,
- "currentPage": 1
}, - "links": {
- "self": "/en/v1/{type}",
- "first": "/en/v1/{type}?page=1",
- "last": "/en/v1/{type}?page=80",
- "next": "/en/v1/{type}?page=2"
}, - "data": [
- {
- "id": "/en/v1/profile-schemas/86a8a563-93c6-5ee0-8925-45d32e02490b",
- "type": "ProfileSchemaV1",
- "attributes": {
- "uuid": "86a8a563-93c6-5ee0-8925-45d32e02490b",
- "name": "VIP customers",
- "description": "Profile schema for our VIP customers",
- "additionalAttributesAllowed": false,
- "attributeDefinitions": [
- {
- "type": "string|date|integer",
- "name": "first_name",
- "description": "The attribute that describes the VIP customer's first name",
- "defaultValue": null,
- "identifier": true,
- "descriptor": true,
- "optional": true,
- "personalData": true
}
]
}
}
]
}
locale required | string Example: en Request locale |
uuid required | string Example: 57b897f8-53fa-11ea-b2a4-0242ac120006 |
ProfileSchema item response
ProfileSchema not found response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/profile-schemas/57b897f8-53fa-11ea-b2a4-0242ac120006
{- "data": {
- "id": "/en/v1/profile-schemas/86a8a563-93c6-5ee0-8925-45d32e02490b",
- "type": "ProfileSchemaV1",
- "attributes": {
- "uuid": "86a8a563-93c6-5ee0-8925-45d32e02490b",
- "name": "VIP customers",
- "description": "Profile schema for our VIP customers",
- "additionalAttributesAllowed": false,
- "attributeDefinitions": [
- {
- "type": "string|date|integer",
- "name": "first_name",
- "description": "The attribute that describes the VIP customer's first name",
- "defaultValue": null,
- "identifier": true,
- "descriptor": true,
- "optional": true,
- "personalData": true
}
]
}
}
}
locale required | string Example: en Request locale |
page | integer Example: page=1 Page number |
Survey collection response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/surveys
{- "meta": {
- "totalItems": 2379,
- "itemsPerPage": 30,
- "currentPage": 1
}, - "links": {
- "self": "/en/v1/{type}",
- "first": "/en/v1/{type}?page=1",
- "last": "/en/v1/{type}?page=80",
- "next": "/en/v1/{type}?page=2"
}, - "data": [
- {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f",
- "attributes": {
- "uuid": "61cd3277-542e-11ea-a019-4201ac1ac00f",
- "title": "Employee satisfaction"
}
}
]
}
locale required | string Example: en Request locale |
uuid required | string Example: 57b897f8-11ea-b2a4-53fa-0242be220006 Survey UUID |
Survey item response
Survey not found response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/surveys/57b897f8-11ea-b2a4-53fa-0242be220006
{- "data": {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f",
- "attributes": {
- "uuid": "61cd3277-542e-11ea-a019-4201ac1ac00f",
- "title": "Employee satisfaction"
}
}
}
locale required | string Example: en Request locale |
page | integer Example: page=1 Page number |
Custom access code collection response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/custom-access-codes
{- "links": {
- "self": "/en/v1/{type}",
- "first": "/en/v1/{type}?page=1",
- "last": "/en/v1/{type}?page=80",
- "next": "/en/v1/{type}?page=2"
}, - "meta": {
- "totalItems": 2379,
- "itemsPerPage": 30,
- "currentPage": 1
}, - "data": [
- {
- "id": "/en/v1/custom-access-codes/5S767T",
- "type": "CustomAccessCodeV1",
- "attributes": {
- "code": "5S767T",
- "singleParticipation": true,
- "expiresAt": "2020-06-23T21:27:00.000+01:00",
- "createdAt": "2012-02-28T21:27:00.000+01:00"
}, - "relationships": {
- "subject": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "object": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "survey": {
- "data": {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f"
}
}
}
}
]
}
locale required | string Example: en Request locale |
data required | object |
Custom access code creation response
Bad request response
{- "data": {
- "type": "CustomAccessCodeV1",
- "attributes": {
- "singleParticipation": true,
- "expiresAt": "2020-06-23T21:27:00.000+01:00"
}, - "relationships": {
- "subject": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "object": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "survey": {
- "data": {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f"
}
}
}
}
}
{- "data": {
- "type": "CustomAccessCodeV1",
- "attributes": {
- "code": "3vlmQB",
- "singleParticipation": true,
- "expiresAt": "2020-06-23T21:27:00.000+01:00",
- "createdAt": "2019-06-23T21:27:00.000+01:00"
}, - "relationships": {
- "subject": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "object": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "survey": {
- "data": {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f"
}
}
}
}
}
locale required | string Example: en Request locale |
code required | string Example: 5S767T Unique code |
Custom access code item response
Custom access code not found response
curl -X GET \ -H 'X-EchonovumApi-Key: YOUR_API_KEY' \ -H 'Content-Type: application/vnd.api+json' \ https://api.echonovum.com/en/v1/custom-access-codes/5S767T
{- "data": {
- "id": "/en/v1/custom-access-codes/5S767T",
- "type": "CustomAccessCodeV1",
- "attributes": {
- "code": "5S767T",
- "singleParticipation": true,
- "expiresAt": "2020-06-23T21:27:00.000+01:00",
- "createdAt": "2012-02-28T21:27:00.000+01:00"
}, - "relationships": {
- "subject": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "object": {
- "data": {
- "type": "ProfileV1",
- "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b"
}
}, - "survey": {
- "data": {
- "type": "SurveyV1",
- "id": "/en/v1/surveys/61cd3277-542e-11ea-a019-4201ac1ac00f"
}
}
}
}
}