Search the authenticated utility tenant
LogsGET /search
Searches across the resources of the authenticated tenant. The tenant always comes from the token. Lookups run concurrently with a per-request timeout. Sources the caller's scopes exclude are omitted; a source that fails for any other reason is omitted and partial becomes true. Meters match by serial number, by the number of the account they are installed on (only for callers who may read accounts) and by exact meter ID; an exact serial ranks first.
Parameters
qSearch text, trimmed before use.
typesComma-separated subset of [customer, account, property, meter, connection, invoice, payment, ticket, work_order, incident, reading_route]. Defaults to all of them; an unknown type is rejected.
limitMaximum results per type (default 5, larger values are clamped to 20).
Returns
200 Matching resources, grouped by type in a stable order
Show attributes
dataShow child attributes
typeone of
customer,account,property,meter,connection,invoice,payment,ticket,work_order,incident,reading_route,organization, …idtitleWhat a person recognises, such as a name, invoice number or serial.
subtitleOne line of context.
status
queryThe trimmed search text.
partialTrue when at least one source failed and its results are missing.
Permissions business:accounts:read, business:customers:read, business:metadata:read, business:meters:read, business:properties:read, business:reading-routes:read, connections:read, invoices:read, operations:read, payments:read, support:read · Roles: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/search" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/search", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/search",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/search", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"type": "customer",
"id": "sea_2IoPVOcVNUC7fuGnj6ErdMyrjuU",
"title": "Fuga na Rua 3",
"subtitle": "subtitle",
"status": "active"
}
],
"query": "query",
"partial": true
}