Search for entity by ReltioID or Custom UID

Learn about searching for an entity using the Reltio ID or Custom UID.

Take a sneak peek at Reltio ID - your unique, durable identifier.

Use the getByReltioID API to search for an entity in a tenant. It returns an entity object (full or partial) by ReltioID or Custom UID (crosswalk value and source type) from the tenant.

Request

GET {TenantURL}/entities/_byReltioId/1ed44bbe-ce65-8066-a07b-000027125fa0
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512

Where 1ed44bbe-ce65-8066-a07b-000027125fa0 is the reltioId parameter value

Table 1. Parameters
Parameter		Required	Details
Headers	`Authorization`	Yes	Stores the information about the authentication access token in the format "Bearer `<accessToken>`". For more information, see topic Authentication API).
Path	`reltioId`	Yes	Identifier of the object defined in the reltioid source property. For example, the Reltio Platform generates an assigned ReltioID for all entities.
Query	`options`	No	Comma-separated values that generate a response based on the option provided. Following are the options: sendHidden - disabled by default. The entity's JSON contains hidden attributes if this option is enabled. ovOnly - returns only attribute values that have the ov flag set to true. nonOvOnly - returns only attribute values that have the ov flag set to false. If any nested or reference attribute values have the ov flag set to true and subattributes with the ov flag set to false, then these subattributes don’t appear in the response.
Query	`select`	No	Generates a comma-separated list of properties from the entity structure that must be returned in a response. The response generates a partial entity object. For the `select` parameter, you can use the following fields in the request query: uri type tags createdBy createdTime updatedBy updatedTime isFavorite analyticsAttributes label secondaryLabel crosswalks attributes For example: `select=attributes.FirstName,attributes.LastName` `select=attributes` The first query retrieves only the entity's first name and last name in the response. The second query retrieves all the entity's attributes. Additional system properties are: `attributes._lookupCodes`: returns lookup codes for lookup attributes. `attributes._lookupValues`: returns values for lookup attributes. For example, `select=uri,label,attributes._lookupCodes,attributes._lookupValues.`

Response

A JSON array with the object that contains the reltioId parameter.

GET /entities/_byReltioId/1ed44bbe-ce65-8066-a07b-000027125fa0
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
[
    {
        "index": 0,
        "object": {
            "uri": "entities/00iMTXU",
            "type": "configuration/entityTypes/Individual",
            "createdBy": "yourname@yourcompany.com",
            "createdTime": 1664980943642,
            "updatedBy": "yourname@yourcompany.com",
            "updatedTime": 1664980943642,
            "attributes": {
                "RID": [
                    {
                        "type": "configuration/entityTypes/Individual/attributes/RID",
                        "ov": true,
                        "value": "1ed44bbe-ce65-8066-a07b-000027125fa0",
                        "uri": "entities/00iMTXU/attributes/RID/2ucv3tg"
                    }
                ],
                "LastName": [
                    {
                        "type": "configuration/entityTypes/Individual/attributes/LastName",
                        "ov": true,
                        "value": "L1",
                        "uri": "entities/00iMTXU/attributes/LastName/2ucumqe"
                    }
                ],
                "FirstName": [
                    {
                        "type": "configuration/entityTypes/Individual/attributes/FirstName",
                        "ov": true,
                        "value": "F1",
                        "uri": "entities/00iMTXU/attributes/FirstName/2ucuiaO"
                    }
                ]
            },
            "isFavorite": false,
            "crosswalks": [
                {
                    "uri": "entities/00iMTXU/crosswalks/2ucur6u",
                    "type": "configuration/sources/OTM",
                    "value": "cw_e1",
                    "reltioLoadDate": "2022-10-05T10:42:23.642-04:00",
                    "createDate": "2022-10-05T10:42:23.642-04:00",
                    "updateDate": "2022-10-05T10:42:23.642-04:00",
                    "attributes": [
                        "entities/00iMTXU/attributes/LastName/2ucumqe",
                        "entities/00iMTXU/attributes/FirstName/2ucuiaO"
                    ],
                    "singleAttributeUpdateDates": {}
                },
                {
                    "uri": "entities/00iMTXU/crosswalks/2ucuvNA",
                    "type": "configuration/sources/ReltioID",
                    "value": "1ed44bbe-ce65-8066-a07b-000027125fa0",
                    "reltioLoadDate": "2022-10-05T10:42:23.642-04:00",
                    "createDate": "2022-10-05T10:42:23.642-04:00",
                    "updateDate": "2022-10-05T10:42:23.642-04:00",
                    "attributes": [
                        "entities/00iMTXU/attributes/RID/2ucv3tg"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ],
            "analyticsAttributes": {},
            "label": "",
            "secondaryLabel": ""
        },
        "successful": true
    }
]

Unify and manage your data

Search for entity by ReltioID or Custom UID

Footer