Skip to main content
GET
Get connected entities

Authorizations

Authorization
string
header
required

Headers

Idempotency-Key
string

A unique value per logical call. Retrying with the same key within seven days returns the stored response at no charge.

Required string length: 1 - 256

Path Parameters

q_id
string
required

Entity id: addr_, parc_, acct_ or unit_ followed by a UUID. Get one from find.

Pattern: ^(addr|parc|acct|unit)_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

depth
integer
default:2

How many links to follow, 1–3. Default 2.

Required range: 1 <= x <= 3

Response

Success

contract_version
any
required
request_id
string
required

Your Idempotency-Key, or a generated id.

operation
string
required
status
enum<string>
required
Available options:
ok,
error
data
object
required
error
object | null
required
meta
object
required