Skip to content

Client.relationship_types

Foundry relationship type catalog for the default team.

Signature

@property
relationship_types -> ResourceCollection[RelationshipType]

HTTP parameters

Name In Type Required Default
limit query integer no 0
offset query integer no 0
q query string no -

Return shape

HTTP 200 — OK

array<RelationshipTypeSchema>

Permission

Required permission: Any signed-in user

HTTP

GET /api/foundry/relationship-types/ (listRelationshipTypes)

Usage

client.relationship_types