cloudsprite.relationship_types¶
Foundry relationship type catalog for the default team.
Module convenience alias for Client.relationship_types (process-default client). Not listed in __all__.
Signature¶
@property
cs.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¶
cs.relationship_types