Read relation tuples

GET/relations

Reads tuples of the caller's organization.

Query parameters

namespaceoptional string

Namespace

object_idoptional string

Object ID

relationoptional string

Relation

Headers

Authorizationstring

Bearer <token>.

Returns

200OKarray of RelationTuple

created_atoptional string

idoptional string

namespaceoptional string

resource type: "document"

object_idoptional string

resource id

organization_idoptional string

relationoptional string

"owner", "editor", "viewer"

subject_idoptional string

user/group id

subject_relationoptional string

for userset rewrite: namespace:object#relation

subject_typeoptional string

"user", "group", "namespace"

GET Request

curl --request GET \
  --url 'https://api.hexelstudio.com/v1/relations' \
  --header "Authorization: Bearer $ACCESS_TOKEN"

const res = await fetch("https://api.hexelstudio.com/v1/relations", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
  },
})
const data = await res.json()

import os
import requests

res = requests.get(
    "https://api.hexelstudio.com/v1/relations",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
)
data = res.json()

Response

[
  {
    "created_at": "2026-01-01T00:00:00Z",
    "id": "string",
    "namespace": "string",
    "object_id": "string",
    "organization_id": "string",
    "relation": "string",
    "subject_id": "string",
    "subject_relation": "string",
    "subject_type": "string"
  }
]