GET item by identifier attribute

/en/v1/profiles/{identifierName}/value/{identifierValue}

Use this endpoint to retrieve a profile resource by its identifier attribute and not by its 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/profiles/Employee%20ID/value/SIR

const API_KEY = process.env.ECHONOVUM_API_KEY;

const response = await fetch('https://api.echonovum.com/en/v1/profiles/Employee%20ID/value/SIR', {
    headers: {
        'X-EchonovumApi-Key': API_KEY,
        'Content-Type': 'application/vnd.api+json'
    }
});

Responses

{
  "data": {
    "id": "/en/v1/profiles/86a8a563-93c6-5ee0-8925-45d32e02490b",
    "type": "ProfileV1",
    "attributes": {
      "uuid": "fe14dace-7832-4b64-9bfd-9f8b7690883a",
      "identifier": "Employee ID",
      "name": "Name",
      "attributes": {
        "Employee ID": "SIR",
        "Name": "Siri",
        "Department": "Customer Success",
        "Email": "siri@echonovum.com",
        "Mobile": "+41790000000",
        "Role": "CS Hero"
      },
      "accessCodes": {
        "subject": "PsV434",
        "object": "MgP2e3"
      },
      "allowMultisurvey": false
    }
  }
}

{
  "title": "An error occurred",
  "description": "Profile not found with identifier: \u0022Employee ID\u0022 and value: \u0022SIR\u0022"
}

Last modified: 27 May 2024