Skip to navigation
Atomicwork Public APIEntities

Get all linked entities with relationship information

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

entity_typeenumRequired

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

display_idstringRequired

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

Headers

X-Workspace-IdstringOptional

Query parameters

reference_keystringOptional
Reference key of the implicit relationship field definition
pageintegerOptional>=1Defaults to 1
Page number for pagination
per_pageintegerOptional1-1000Defaults to 10
Number of items per page
search_keystringOptional
Search keyword to filter linked entities by display ID or subject

Response

Successful response