Get Relation by crosswalk
Learn how to retrieve a full or partial relation object using a crosswalk value and source type.
Use this API to retrieve a relation object (full or partial) from a tenant using a crosswalk value and its associated source type. The response includes the relations participating entities, crosswalks, and attributes.
HTTP method and endpoint
Submit the request using the following HTTP method and endpoint path. Replace {TenantURL} with your tenant base URL.
GET {TenantURL}/relations/_byCrosswalk/{crosswalkValue}?type={sourceType}Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer token in the format Bearer <accessToken>. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
crosswalkValue | String | Yes | ID of the relation object in the source system. |
type | String | Yes | Source type of the crosswalk, referenced by its URI. |
sourceTable | String | No | Source table parameter of the crosswalk. |
options | String (comma-separated) | No | Modifies the response. Supported values include:
|
Example request
GET {TenantURL}/relations/_byCrosswalk/00007vP?type=Reltio
Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
Response fields
| Field | Type | Description |
|---|---|---|
uri | String | URI of the returned relation object |
type | String | Relation type from the business model |
startObject | Object | Metadata of the start entity, including type and object URI |
endObject | Object | Metadata of the end entity, including type and object URI |
attributes | Object | Relation attributes and values |
crosswalks | Array | Crosswalks associated with the relation |
Example response
{
"uri": "relations/00007vP",
"type": "configuration/relationTypes/HasAddress",
"createdBy": "some_user",
"createdTime": 1679920845583,
"updatedBy": "some_another_user",
"updatedTime": 1727877943059,
"startRefPinned": false,
"startRefIgnored": false,
"endRefPinned": false,
"endRefIgnored": false,
"attributes": {
"AddressType": [
{
"type": "configuration/relationTypes/HasAddress/attributes/AddressType",
"ov": true,
"value": "SomeAddressType",
"uri": "relations/00007vP/attributes/AddressType/1ntBoi"
}
]
},
"analyticsAttributes": {},
"crosswalks": [
{
"uri": "relations/00007vP/crosswalks/1nuHnq",
"type": "configuration/sources/Reltio",
"value": "00007vP",
"reltioLoadDate": "2024-10-02T14:05:43.059Z",
"createDate": "2023-03-27T12:40:45.583Z",
"updateDate": "2023-11-29T17:26:29.430Z",
"attributes": [
"relations/00007vP/attributes/AddressType/1ntBoi"
]
}
],
"startObject": {
"type": "configuration/entityTypes/HCP",
"objectURI": "entities/b8Puigo",
"label": "Some HCP Label",
"directionalLabel": "has address",
"crosswalks": [
{
"uri": "entities/b8Puigo/crosswalks/2QHPguqn5",
"type": "configuration/sources/Reltio",
"value": "b8Puigo",
"reltioLoadDate": "2025-09-10T10:25:31.849Z",
"createDate": "2022-09-26T01:20:59.128Z",
"updateDate": "2022-09-26T01:20:59.128Z",
"attributes": [
"entities/b8Puigo/attributes/LastName/5K2sr89p",
"entities/b8Puigo/attributes/FirstName/5V2sr3tp"
],
"singleAttributeUpdateDates": {
"entities/b8Puigo/attributes/LastName/5K2sr89p": "2024-12-20T04:48:43.846Z",
"entities/b8Puigo/attributes/FirstName/5V2sr3tp": "2024-12-20T04:48:43.846Z"
}
}
]
},
"endObject": {
"type": "configuration/entityTypes/Location",
"objectURI": "entities/QcV3jmk",
"label": "Some Location Label",
"directionalLabel": "locates",
"crosswalks": [
{
"uri": "entities/QcV3jmk/crosswalks/24TblVcQt",
"type": "configuration/sources/Reltio",
"value": "QcV3jmk",
"reltioLoadDate": "2024-12-20T04:50:27.202Z",
"createDate": "2022-09-27T00:59:33.131Z",
"updateDate": "2022-09-27T00:59:33.131Z",
"attributes": [
"entities/QcV3jmk/attributes/City/3cPQn8r7",
"entities/QcV3jmk/attributes/AddressLine1/3qNpH97v",
"entities/QcV3jmk/attributes/StateProvince/3pQRNgap"
],
"singleAttributeUpdateDates": {
"entities/QcV3jmk/attributes/City/3cPQn8r7": "2024-12-20T04:50:27.202Z",
"entities/QcV3jmk/attributes/AddressLine1/3qNpH97v": "2024-12-20T04:50:27.202Z",
"entities/QcV3jmk/attributes/StateProvince/3pQRNgap": "2024-12-20T04:50:27.202Z"
}
}
]
}
}