Listar relações com moradores
RegistosGET /utility-relationships
Pages the relationships people hold with the caller's utility that do not need an account, such as requester, follower or assisted helper, newest first. Each row has the kind, the subject it is about (for example a service request), the status and its start, expiry and end times. The person's global identity key is never returned to business callers, although identity_id can still be used as a filter. Requires business:customers:read. An invalid limit or cursor returns 400.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
identity_idOnly relationships of this identity.
kindOnly relationships of this kind.
um de
requester,follower,assisted_helperstatusOnly relationships in this status.
um de
active,ended,invited,pending_review,suspended,declined,expired
Devolve
200 Relationships in the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idkindWhat the person is to the utility.
um de
requester,follower,assisted_helpersubject_typeType of the record the relationship is about, when it is about one.
subject_idIdentifier of that record.
statusum de
active,ended,invited,pending_review,suspended,declined,expiredstarted_atexpires_atended_atend_reasoncreated_atupdated_at
has_morenext_cursor
Permissões business:customers:read · Funções: admin, analyst, billing_clerk, customer_service, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/utility-relationships" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/utility-relationships", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/utility-relationships",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/utility-relationships", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "bus_26IDFyAP1M8j5sultUq3VOC3R02",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"kind": "requester",
"subject_type": "subject type",
"subject_id": "sub_2Cg5f6gZ7W8jvEm53ICdbaeNrWe",
"status": "active",
"started_at": "2026-11-19T09:30:00Z",
"expires_at": "2026-11-19T09:30:00Z",
"ended_at": "2026-11-19T09:30:00Z",
"end_reason": "end reason",
"created_at": "2026-11-19T09:30:00Z",
"updated_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}