---
title: "Get Relationship Record"
method: GET
path: "/v1/links/{linkId}"
tags: ["Object Relationship Management"]
---

# Get Relationship Record

`GET /v1/links/{linkId}`

## Request

- Base URL: `https://hostname/api/custom-entity`
- URL: `https://hostname/api/custom-entity/v1/links/{linkId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `OBJECT_MANAGER`, `OBJECT_MANAGER_READ`, `OBJECT_MANAGER_WRITE`

Use this API to retrieve the details of a specific Relationship Record between objects.

> 🗒 Things to Know
> 
> - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

## Path parameters

- `linkId` string, uuid, required: Unique identifier of the link record to retrieve

## Query parameters

- `linkTypeId` string, uuid, required: Unique identifier of the link type

## Response `200`

OK - Returns the complete details of the requested relationship

- LinkInformation
  - `id` string, uuid, required: The unique identifier of the relationship record.
  - `linkType` IdOrNameLinkType, required
    - `id` string, uuid: The unique identifier of the relationship type.
    - `name` string: The name of the relationship type.
    - `idOrNamePresent` boolean: This flag indicates whether the ID or name of the relationship type is present.
  - `linkTypeLabel` BasicLinkTypeLabelInformation
    - `id` integer, required: The unique identifier of the relationship type.
    - `entityType1ToEntityType2EntityLinkName` string: The source object type's relationship to the target object type.
    - `entityType2ToEntityType1EntityLinkName` string: The target object type's relationship to the source object type.
  - `entity1` LinkedEntityInformation, required
    - `linkEntityDetail` EntityDetailRequest
      - `extendedBaseAttributes` object: The details of the attribute.
    - `id` string, uuid, required: The unique identifier of the object.
    - `number` integer, required: The sequential order in which the object was created.
    - `name` string: The name of the object.
    - `detailsAccessRestricted` boolean: This flag indicates whether the object is view-only.
    - `redirectURL` string: The redirect URL for the object.
    - `entityType` BasicEntityTypeInformation, required
      - `id` string, uuid, required: The unique identifier of the object type.
      - `name` string, required: The name of the object type.
      - `seeded` boolean: This flag indicates whether the object type is seeded.
      - `moduleName` 'Vendor' | 'DataMapping' | 'Risk' | 'Assessments' | 'CustomEntityManagement': The name of the product where the object type exists.
      - `schemaName` 'vendor' | 'data-mapping' | 'risk' | 'assessments' | 'customEntityManagement': The name of the schema.
    - `deleted` boolean: This flag indicates whether the object is deleted.
  - `entity2` LinkedEntityInformation, required
    - `linkEntityDetail` EntityDetailRequest
      - `extendedBaseAttributes` object: The details of the attribute.
    - `id` string, uuid, required: The unique identifier of the object.
    - `number` integer, required: The sequential order in which the object was created.
    - `name` string: The name of the object.
    - `detailsAccessRestricted` boolean: This flag indicates whether the object is view-only.
    - `redirectURL` string: The redirect URL for the object.
    - `entityType` BasicEntityTypeInformation, required
      - `id` string, uuid, required: The unique identifier of the object type.
      - `name` string, required: The name of the object type.
      - `seeded` boolean: This flag indicates whether the object type is seeded.
      - `moduleName` 'Vendor' | 'DataMapping' | 'Risk' | 'Assessments' | 'CustomEntityManagement': The name of the product where the object type exists.
      - `schemaName` 'vendor' | 'data-mapping' | 'risk' | 'assessments' | 'customEntityManagement': The name of the schema.
    - `deleted` boolean: This flag indicates whether the object is deleted.
  - `schemaId` string, uuid: The unique identifier of the schema.
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required: The date and time that the record was created.
    - `lastUpdatedDate` string, date-time: The date and time that the record was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the record.
      - `name` string: The name of the user who last modified the record.
      - `email` string: The email address of the user who last modified the record.
      - `initials` string: The initials of the user who last modified the record.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the record.
      - `name` string: The name of the user who last modified the record.
      - `email` string: The email address of the user who last modified the record.
      - `initials` string: The initials of the user who last modified the record.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/platform-object-manager.md) - [All operations](https://skmtc.dev/onetrust/apis/platform-object-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/platform-object-manager/revisions/76e5833717c3?raw)