List field visit records and inspection outcomes
LogsGET /field-visits
Returns field visit records of the tenant with outcome, reader, location, evidence and revisit details. Filters combine, the handler also accepts route_id and cycle_id, and results are cursor-paginated (default 20, maximum 100). An unknown outcome value returns 400. Requires the business:field-visits:read permission.
Parameters
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
meter_idReturn only visits to this meter.
account_idReturn only visits to meters of this service account.
reader_idReturn only visits recorded by this staff member (the identity that submitted the visit).
outcomeReturn only visits with this outcome: read, inaccessible, damaged or not_found; any other value returns 400.
one of
read,inaccessible,damaged,not_foundrevisit_requiredWhen
trueor 1, return only visits that need a revisit; any other value returns only visits that do not; omit to include both.
Returns
200 Field visits list
Show attributes
dataShow child attributes
idtenant_idmeter_idmeter_serialSerial number of the referenced meter. Omitted when unknown.
meter_holder_nameDisplay name of the customer who holds the account the meter is installed on. Omitted when unknown.
account_idaccount_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.
assignment_idroute_idcycle_idreader_idvisited_atoutcomeone of
read,inaccessible,damaged,not_foundreading_idlatitudelongitudeevidence_idsnotesrevisit_requiredrevisit_reasonrevisit_scheduled_atcreated_at
has_morenext_cursor
Errors 403
Permissions business:field-visits:read · Roles: admin, analyst, field_reader, field_supervisor, operations, owner
curl -X GET "$BUSINESS_API/field-visits" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/field-visits", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/field-visits",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/field-visits", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "fie_2CaHRWCx7GgdfmOznKWVHUOVNas",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
"meter_serial": "meter serial",
"meter_holder_name": "Ana Matsinhe",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"assignment_id": "ass_2bVAYnXSmDHuMvxsMpR2Q93SOVR",
"route_id": "rte_2Tzu6NZioJBSiX9CSX5qObtq4Zt",
"cycle_id": "cyc_2o6Z32az1oKF1ykfNkmdxACDLcy",
"reader_id": "rea_2z56md1eSXHYIhXoEFxw6B7cIbr",
"visited_at": "2026-11-19T09:30:00Z",
"outcome": "read",
"reading_id": "rdg_2o0xXwujnSgR9QIvVEWblWSv7u0",
"latitude": -25.9653,
"longitude": 32.5892,
"evidence_ids": [
"evi_2N98GhhgsvHGkNNqQ3LICnXai7r"
],
"notes": "Leitura confirmada no local.",
"revisit_required": true,
"revisit_reason": "revisit reason",
"revisit_scheduled_at": "2026-11-19T09:30:00Z",
"created_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}