Listar áreas de serviço
RegistosGET /service-areas
Returns a cursor-paginated page of the tenant's service areas, the geographic zones used to group properties and reading routes. You can also pass q to match part of the name (case-insensitive), and limit and after to page. Requires business:service-areas:read.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
qResource-specific text search.
statusReturns only service areas with this exact status, for example active; omit it to return all.
Devolve
200 Service areas in the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idnamestatus
has_morenext_cursor
Permissões business:service-areas:read · Funções: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, finance, operations, owner, viewer
curl -X GET "$BUSINESS_API/service-areas" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/service-areas", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/service-areas",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/service-areas", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"name": "Ana Matsinhe",
"status": "active"
}
],
"has_more": true,
"next_cursor": "next cursor"
}