Query relationships

GET {{baseUrl}}/relation-tuples?page_token=<string>&page_size=<long>&namespace=<string>&object=<string>&relation=<string>&subject_id=<string>&subject_set.namespace=<string>&subject_set.object=<string>&subject_set.relation=<string>

Get all relationships that match the query. Only the namespace field is required.

Request Params

KeyDatatypeRequiredDescription
page_tokenstring
page_sizestring
namespacestringNamespace of the Relationship
objectstringObject of the Relationship
relationstringRelation of the Relationship
subject_idstringSubjectID of the Relationship
subject_set.namespacestringNamespace of the Subject Set
subject_set.objectstringObject of the Subject Set
subject_set.relationstringRelation of the Subject Set

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;relation_tuples&quot;:[{&quot;namespace&quot;:&quot;\u003cstring\u003e&quot;,&quot;object&quot;:&quot;\u003cstring\u003e&quot;,&quot;relation&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject_set&quot;:{&quot;namespace&quot;:&quot;\u003cstring\u003e&quot;,&quot;object&quot;:&quot;\u003cstring\u003e&quot;,&quot;relation&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;namespace&quot;:&quot;\u003cstring\u003e&quot;,&quot;object&quot;:&quot;\u003cstring\u003e&quot;,&quot;relation&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;subject_set&quot;:{&quot;namespace&quot;:&quot;\u003cstring\u003e&quot;,&quot;object&quot;:&quot;\u003cstring\u003e&quot;,&quot;relation&quot;:&quot;\u003cstring\u003e&quot;}}]}