echonovum Docs Help

GET item

GET method/en/v1/profile-schemas/{uuid}

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/57b897f8-53fa-11ea-b2a4-0242ac120006
const API_KEY = process.env.ECHONOVUM_API_KEY; const response = await fetch('https://api.echonovum.com/en/v1/profile-schemas/57b897f8-53fa-11ea-b2a4-0242ac120006', { headers: { 'X-EchonovumApi-Key': API_KEY, 'Content-Type': 'application/vnd.api+json' } });

Responses

{ "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 } ] } } }
{ "title": "An error occurred", "description": "Not Found" }
Last modified: 27 May 2024