List the caller's relationships with utilities
LogsGET /relationships
Returns one list, newest first, of everything that links the signed-in person to a utility: account memberships (as holder, delegate, payer, tenant or landlord, with the permissions each grants) and utility-only relationships the person started (requester or follower). Ended and expired entries are included unless filtered out. The caller must be a consumer identity that is not bound to a tenant; otherwise the response is 403.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
kindReturn only entries of this kind: holder, delegate, payer, tenant, landlord, requester or follower.
statusReturn only entries in this status, for example active, pending_review, ended or expired.
Returns
200 The caller's relationships
Show attributes
dataRelationships, newest first.
Show child attributes
idMembership ID for an account-bound entry, or utility relationship ID (prefix
ulr) for a utility-only entry. Pass it to the end call.tenant_idUtility the relationship is with.
tenant_nameDisplay name of the utility; falls back to the tenant ID when the utility has no name.
kindRelationship kind.
one of
holder,delegate,payer,tenant,landlord,requester,followeraccount_idAccount of an account-bound entry.
account_numberNumber of the referenced account, e.g. CTA-000044. Omitted when unknown.
account_holder_nameDisplay name of the customer who holds the referenced account. Omitted when unknown.
subject_labelLabel to show for an account-bound entry; the account number, or the account ID when it has no number.
subject_typeType of the subject of a utility-only entry, as given when it was created.
subject_idIdentifier of the subject of a utility-only entry.
permissionsAccount permissions the membership grants. Omitted for utility-only entries.
statusCurrent status; a membership past its expiry that was never ended reports expired.
one of
invited,pending_review,active,suspended,ended,declined,expiredstarted_atcreated_atexpires_atended_at
has_moreTrue when another page follows.
next_cursorOpaque cursor for the next page; present only when has_more is
true.
curl -X GET "$CONSUMER_API/relationships" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/relationships", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/relationships",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/relationships", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "con_2FxsaDbgur7MKnHo6RdmsNhQOT1",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"tenant_name": "Ana Matsinhe",
"kind": "holder",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"subject_label": "subject label",
"subject_type": "subject type",
"subject_id": "sub_2Cg5f6gZ7W8jvEm53ICdbaeNrWe",
"permissions": [
"account.read"
],
"status": "invited",
"started_at": "2026-11-19T09:30:00Z",
"created_at": "2026-11-19T09:30:00Z",
"expires_at": "2026-11-19T09:30:00Z",
"ended_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}