Listar contas
RegistosGET /accounts
Lists the service accounts of the caller's workspace, optionally filtered by customer, property, status and a free-text q search. Results are paginated with limit (default 20, maximum 100) and the after cursor; a negative or non-numeric limit returns 400. Requires the business:accounts:read permission.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
qResource-specific text search.
customer_idCustomer identifier; when set, only accounts belonging to that customer are returned.
property_idProperty identifier; when set, only accounts opened for that property are returned.
statusAccount status to keep: active, suspended or closed; when omitted, accounts in every status are returned.
um de
active,suspended,closed
Devolve
200 Utility accounts
Mostrar atributos
dataMostrar atributos filhos
idtenant_idtenant_slugThe utility's slug, so a client can brand the account. Omitted when unknown.
customer_idcustomer_nameDisplay name of the referenced customer. Omitted when unknown.
property_idproperty_addressAddress line of the referenced property. Omitted when unknown.
permissionsPresent only in consumer responses and lists the authenticated identity's permissions for this account.
account_numberbilling_entity_idstatusum de
active,suspended,closedopened_atclosed_at
has_morenext_cursor
Permissões business:accounts:read · Funções: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/accounts" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/accounts", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/accounts",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/accounts", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"tenant_slug": "tenant slug",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"property_id": "prp_2ZbuIh1k2RvWMVPQCJD2yPrsOJ3",
"property_address": "Av. Julius Nyerere 1420, Maputo",
"permissions": [
"account.read"
],
"account_number": "ACC-2026-000142",
"billing_entity_id": "bil_2lLuuZnocVf6qrPO4rXsSdtAi95",
"status": "active",
"opened_at": "2026-11-19T09:30:00Z",
"closed_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}