GET collection
Request parameters
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
const API_KEY = process.env.ECHONOVUM_API_KEY;
const response = await fetch('https://api.echonovum.com/en/v1/profile-schemas', {
headers: {
'X-EchonovumApi-Key': API_KEY,
'Content-Type': 'application/vnd.api+json'
}
});
Responses
{
"meta": {
"totalItems": 2379,
"itemsPerPage": 30,
"currentPage": 1
},
"links": {
"self": "/en/v1/profile-schemas",
"first": "/en/v1/profile-schemas?page=1",
"last": "/en/v1/profile-schemas?page=80",
"next": "/en/v1/profile-schemas?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": [
{
"name": "Department",
"description": "",
"type": "string",
"optional": false,
"personalData": false,
"identifier": false,
"descriptor": false,
"excludedFromSnapshots": false,
"sendoutRelated": false
},
{
"name": "E-Mail",
"description": "",
"type": "string",
"optional": false,
"personalData": true,
"identifier": false,
"descriptor": false,
"excludedFromSnapshots": true,
"sendoutRelated": true
},
{
"name": "Employee ID",
"type": "string",
"optional": false,
"personalData": true,
"identifier": true,
"descriptor": false,
"excludedFromSnapshots": false,
"sendoutRelated": false
},
{
"name": "Mobile",
"description": "",
"type": "string",
"optional": false,
"personalData": true,
"identifier": false,
"descriptor": false,
"excludedFromSnapshots": true,
"sendoutRelated": true
},
{
"name": "Name",
"type": "string",
"optional": false,
"personalData": true,
"identifier": false,
"descriptor": true,
"excludedFromSnapshots": false,
"sendoutRelated": false
},
{
"name": "Role",
"description": "",
"type": "string",
"optional": false,
"personalData": false,
"identifier": false,
"descriptor": false,
"excludedFromSnapshots": false,
"sendoutRelated": false
}
]
}
}
]
}
Last modified: 27 May 2024