#Relationships

---

#GET /{o}/{p}/envs/{envName}/relationships

List relationships

List relationships in this environment with optional filtering and pagination.

Auth: Bearer token required · Permission: data:read

Path parameters

Name	Type	Description
o	string
p	string
envName	string

Responses

Status	Description	Schema
200	Relationships	RelationshipList

---

#POST /{o}/{p}/envs/{envName}/relationships

Create a relationship

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string

Request body (application/json)

Field	Type	Description
kind	Relationship	(required)
relationshipType	string	(required)
from	string	(required)
to	string	(required)
state	string
properties	object
labels	object

Responses

Status	Description	Schema
201	Created relationship	Relationship
403	Cell-scope violation	Error
404	RelationshipType or entity not found	Error

---

#GET /{o}/{p}/envs/{envName}/relationships/{id}

Get a relationship by id

Auth: Bearer token required · Permission: data:read

Path parameters

Name	Type	Description
o	string
p	string
envName	string
id	string

Responses

Status	Description	Schema
200	The relationship	Relationship
404	Relationship not found	Error

---

#PUT /{o}/{p}/envs/{envName}/relationships/{id}

Update a relationship

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string
id	string

Request body (application/json)

Field	Type	Description
state	string
properties	object
labels	object

Responses

Status	Description	Schema
200	Updated relationship	Relationship
403	Cell-scope violation	Error
404	Relationship not found	Error

---

#DELETE /{o}/{p}/envs/{envName}/relationships/{id}

Delete a relationship

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string
id	string

Responses

Status	Description	Schema
200	Deletion result	DeletedById
404	Relationship not found	Error

---

#PUT /{o}/{p}/envs/{envName}/relationships/{id}/state

Transition a relationship state

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string
id	string

Request body (application/json)

Field	Type	Description
state	string	(required)

Responses

Status	Description	Schema
200	Updated relationship	Relationship
404	Relationship not found	Error

---

#POST /{o}/{p}/envs/{envName}/relationships/{id}/finalize-deletion

Force-finalize a relationship deletion

Skip the remaining grace period and immediately finalize a relationship scheduled for deletion.

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string
id	string

Request body (application/json)

Field	Type	Description
finalState	string

Responses

Status	Description	Schema
200	Finalized relationship	Relationship
404	Relationship not found	Error
409	No scheduled grace period	Error

#Schemas

#DeletedById

Field	Type	Description
deleted	true	(required)
id	string	(required)

#Error

Field	Type	Description
error	string	(required)
code	string

#Relationship

Field	Type	Description
state	string	(required)
properties	object	(required)
labels	object	(required)
id	string(uuid)	(required)
relationshipTypeName	string	(required)
fromEntityId	string	(required)
toEntityId	string	(required)
envId	string(uuid)	(required)
orgId	string	(required)
projectId	string	(required)
createdAt	string | string	(required)
updatedAt	string | string	(required)

#RelationshipList

Type: Relationship[]