Entities

Get all linked entities with relationship information

GET https://{tenant}.atomicwork.com/api/v1/entities/{entity_type}/{display_id}/links

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Path Parameters

entity_typepathenum (string)required

The entity type (e.g. REQUEST, CHANGE)

Allowed valuesREQUESTSERVICE_REQUESTQUESTION_REQUESTINCIDENT_REQUESTINCIDENTPROBLEM_REQUESTPROBLEMUSERSERVICE_ITEMCUSTOM_FORMSURVEYASSETCHANGECHANGE_TEMPLATECUSTOM_OBJECTNO_OBJECTEXTERNAL_WEBHOOK

display_idpathstringrequired

The display ID of the source entity (e.g. REQ-123, CHG-456)

Query Parameters

reference_keyquerystring

Reference key of the implicit relationship field definition

pagequeryinteger

Page number for pagination

per_pagequeryinteger

Number of items per page

search_keyquerystring

Search keyword to filter linked entities by display ID or subject

Response

200

Successful response