List reading cycles
LogsGET /reading-cycles
Returns a cursor-paginated page of the tenant's reading cycles, each with its code, billing frequency and the day of the month readings are scheduled. You can also pass q for a text search, limit (default 20, maximum 100) and after. Requires the business:reading-cycles:read permission.
Parameters
activeBoolean filter (
true/false, also 1/0):truereturns only active cycles,falseonly inactive ones; omit it to return both, and a value that is not a boolean returns 400.qResource-specific text search.
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
Returns
200 Reading cycles
Permissions business:reading-cycles:read · Roles: admin, analyst, field_reader, field_supervisor, operations, owner
curl -X GET "$BUSINESS_API/reading-cycles" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$BUSINESS_API/reading-cycles", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/reading-cycles",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/reading-cycles", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
Reading cycles