entityId in ProfileAPI | Community
Skip to main content
N
navin_kumar0601
Level 4
April 14, 2023
Solved

entityId in ProfileAPI

  • April 14, 2023
  • 1 reply
  • 1183 views

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

    This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
    Best answer by Hemang35

    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.

    1 reply

    Hemang35
    Hemang35Accepted solution
    Level 5
    April 19, 2023

    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.

      Terms & ConditionsAccessibility statement

      Loading footer...