echonovum API (v1)

Download OpenAPI specification:Download

AUTHENTICATION

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.

CONTENT TYPES

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

PAGINATION

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

Profiles

Retrieves a profile collection

path Parameters
locale
required
string
Example: en

Request locale

query Parameters
page
integer
Example: page=1

Page number

Responses

200

Profile collection response

get /{locale}/v1/profiles
https://api.echonovum.com/{locale}/v1/profiles

Request samples

Copy
curl -X GET \
    -H 'X-EchonovumApi-Key: YOUR_API_KEY' \
    -H 'Content-Type: application/vnd.api+json' \
    https://api.echonovum.com/en/v1/profiles

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "links":
    {
    },
  • "data":
    [
    ]
}

Creates a new profile resource

path Parameters
locale
required
string
Example: en

Request locale

Request Body schema: application/vnd.api+json
One of
  • Profile-post-body-one
  • Profile-post-body-several
  • Profile-post-with-schema-body-one
  • Profile-post-with-schema-body-several
data
required
object

Responses

202

Profile creation response

400

Bad request response

422

Unprocessable entity response

post /{locale}/v1/profiles
https://api.echonovum.com/{locale}/v1/profiles

Request samples

Content type
application/vnd.api+json
Example
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Creates a single new profile resource synchronously

path Parameters
locale
required
string
Example: en

Request locale

Request Body schema: application/vnd.api+json
One of
  • Profile-post-body-one
  • Profile-post-with-schema-body-one
data
required
object

Responses

201

Profile creation response

400

Bad request response

post /{locale}/v1/sync/profiles
https://api.echonovum.com/{locale}/v1/sync/profiles

Request samples

Content type
application/vnd.api+json
Example
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Retrieves a profile resource

path Parameters
locale
required
string
Example: en

Request locale

uuid
required
string
Example: 57b897f8-53fa-11ea-b2a4-0242ac120006

Responses

200

Profile item response

404

Profile not found response

get /{locale}/v1/profiles/{uuid}
https://api.echonovum.com/{locale}/v1/profiles/{uuid}

Request samples

Copy
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

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Deletes a profile resource

path Parameters
locale
required
string
Example: en

Request locale

uuid
required
string
Example: 57b897f8-53fa-11ea-b2a4-0242ac120006

Responses

202

Profile deletion response

404

Profile not found response

delete /{locale}/v1/profiles/{uuid}
https://api.echonovum.com/{locale}/v1/profiles/{uuid}

Request samples

Copy
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

Retrieves a profile resource by its identifier attribute

path Parameters
locale
required
string
Example: en

Request locale

identifierName
required
string
identifierValue
required
string

Responses

200

Profile item response

404

Profile not found response

get /{locale}/v1/profiles/{identifierName}/value/{identifierValue}
https://api.echonovum.com/{locale}/v1/profiles/{identifierName}/value/{identifierValue}

Request samples

Copy
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

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Profile Schemas

Retrieves a profile schema collection

path Parameters
locale
required
string
Example: en

Request locale

query Parameters
page
integer
Example: page=1

Page number

Responses

200

ProfileSchema collection response

get /{locale}/v1/profile-schemas
https://api.echonovum.com/{locale}/v1/profile-schemas

Request samples

Copy
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

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "links":
    {
    },
  • "data":
    [
    ]
}

Retrieves a profile schema resource

path Parameters
locale
required
string
Example: en

Request locale

uuid
required
string
Example: 57b897f8-53fa-11ea-b2a4-0242ac120006

Responses

200

ProfileSchema item response

404

ProfileSchema not found response

get /{locale}/v1/profile-schemas/{uuid}
https://api.echonovum.com/{locale}/v1/profile-schemas/{uuid}

Request samples

Copy
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

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Surveys

Retrieves a survey collection

path Parameters
locale
required
string
Example: en

Request locale

query Parameters
page
integer
Example: page=1

Page number

Responses

200

Survey collection response

get /{locale}/v1/surveys
https://api.echonovum.com/{locale}/v1/surveys

Request samples

Copy
curl -X GET \
    -H 'X-EchonovumApi-Key: YOUR_API_KEY' \
    -H 'Content-Type: application/vnd.api+json' \
    https://api.echonovum.com/en/v1/surveys

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "links":
    {
    },
  • "data":
    [
    ]
}

Retrieves a survey resource

path Parameters
locale
required
string
Example: en

Request locale

uuid
required
string
Example: 57b897f8-11ea-b2a4-53fa-0242be220006

Survey UUID

Responses

200

Survey item response

404

Survey not found response

get /{locale}/v1/surveys/{uuid}
https://api.echonovum.com/{locale}/v1/surveys/{uuid}

Request samples

Copy
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

Response samples

Content type
application/vnd.api+json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Custom Access Codes

Retrieves a custom access code collection

path Parameters
locale
required
string
Example: en

Request locale

query Parameters
page
integer
Example: page=1

Page number

Responses

200

Custom access code collection response

get /{locale}/v1/custom-access-codes
https://api.echonovum.com/{locale}/v1/custom-access-codes

Request samples

Copy
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

Response samples

Content type