Query relationships
GET/relation-tuples
Get all relationships that match the query. Only the namespace field is required.
SDK ReferenceTypeScript
getRelationships()| Parameters | Type | Required | Description |
|---|---|---|---|
| pageSize | number | optional | Items per Page This is the number of items per page to return. For details on pagination please head over to the pagination documentation. |
| pageToken | string | optional | Next Page Token The next page token. For details on pagination please head over to the pagination documentation. |
| namespace | string | optional | Namespace of the Relationship |
| object | string | optional | Object of the Relationship |
| relation | string | optional | Relation of the Relationship |
| subjectId | string | optional | SubjectID of the Relationship |
| subjectSetNamespace | string | optional | Namespace of the Subject Set |
| subjectSetObject | string | optional | Object of the Subject Set |
| subjectSetRelation | string | optional | Relation of the Subject Set |
| Variable | Type |
|---|---|
| data | Relationships |