Skip to main content
GET
traverse_relationships

Authorizations

Authorization
string
header
required

Send Authorization: Bearer qk_… using an API key created in the Quoin Developer Portal.

Path Parameters

entity_ref
string
required
Required string length: 1 - 512

Query Parameters

direction
enum<string>
default:out
Available options:
out,
in,
both
predicates
string[]
Maximum array length: 50
Required string length: 1 - 256
max_depth
integer
default:1
Required range: 1 <= x <= 3
max_nodes
integer
default:200
Required range: 1 <= x <= 200
max_edges
integer
default:200
Required range: 1 <= x <= 200
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string
Required string length: 1 - 4096

Response

Canonical response envelope.

contract_version
string
required
Allowed value: "quoin-v2"
request_id
string
required
Required string length: 1 - 512
operation
string
required
Required string length: 1 - 256
status
enum<string>
required
Available options:
ok,
partial,
error
data
object | null
required
error
object | null
required
meta
object
required
provenance
object | null