Expand my Community achievements bar.

SOLVED

entityId in ProfileAPI

Avatar

Level 4

Team,

 

I am using https://developer.adobe.com/experience-platform-apis/references/profile/#tag/Entities to access a profile, however am not able to understand what is EntityID


string

Example: entityId=GtghAUFkdGVzdDE

ID of the entity. For Native XID lookup, use entityId=<XID> and leave entityIdNS absent; For ID:NS lookup, use both entityId and entityIdNS fields.

Navin

1 Accepted Solution

Avatar

Correct answer by
Community Advisor

Hi Navin,


EntityID in the Adobe Experience Platform API is a unique identifier associated with a specific entity (e.g., a user profile). It helps you look up and interact with an entity in the Experience Platform.


When using the API to access a profile, you can use the EntityID in one of the following ways:

  1. Native XID lookup: If you're using a native Experience Cloud ID (ECID) to look up a profile, set the entityId parameter to the ECID value (e.g., entityId=GtghAUFkdGVzdDE) and leave entityIdNS absent.

  2. ID:NS (ID-Namespace) lookup: If you're using an ID-Namespace combination to look up a profile, use both entityId and entityIdNS fields. The entityId will be the unique identifier for the profile in the specific namespace, and entityIdNS will be the namespace ID.

By providing the appropriate EntityID and, if needed, the entityIdNS, the API will be able to locate and return the profile information you're seeking.

View solution in original post

1 Reply

Avatar

Correct answer by
Community Advisor

Hi Navin,


EntityID in the Adobe Experience Platform API is a unique identifier associated with a specific entity (e.g., a user profile). It helps you look up and interact with an entity in the Experience Platform.


When using the API to access a profile, you can use the EntityID in one of the following ways:

  1. Native XID lookup: If you're using a native Experience Cloud ID (ECID) to look up a profile, set the entityId parameter to the ECID value (e.g., entityId=GtghAUFkdGVzdDE) and leave entityIdNS absent.

  2. ID:NS (ID-Namespace) lookup: If you're using an ID-Namespace combination to look up a profile, use both entityId and entityIdNS fields. The entityId will be the unique identifier for the profile in the specific namespace, and entityIdNS will be the namespace ID.

By providing the appropriate EntityID and, if needed, the entityIdNS, the API will be able to locate and return the profile information you're seeking.