Interruptions

Base URL: $CONSUMER_API

The object

idstring · required
tenant_idstring · required
titlestring · required
interruption_typestring · required

one of maintenance, emergency, rationing

statusstring · required

one of planned, active, completed, cancelled

service_area_idstring · required
dma_idstring · optional
descriptionstring · optional
start_timestring (date-time) · required
end_timestring (date-time) · required
affected_customers_estinteger · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
The object
{
  "id": "sup_2xVSEXVGkjH84PdmebPICxjIkZH",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "title": "Fuga na Rua 3",
  "interruption_type": "maintenance",
  "status": "planned",
  "service_area_id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
  "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
  "description": "Leitura confirmada no local.",
  "start_time": "2026-11-19T09:30:00Z",
  "end_time": "2026-11-19T09:30:00Z",
  "affected_customers_est": 1,
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

List consumer interruptions

Logs

GET /interruptions

Planned or active interruptions affecting the service areas of the caller's accounts

An account's areas are derived from the reading routes covering its meters and from service areas named like the property's locality or district. Finished interruptions are omitted.

Parameters

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

X-Tenant-IDstring · header · optional

Narrow to one of the caller's tenants

Returns

200 Interruptions

Show attributes
dataarray of SupplyInterruption · optional
Show child attributes
idstring · required
tenant_idstring · required
titlestring · required
interruption_typestring · required

one of maintenance, emergency, rationing

statusstring · required

one of planned, active, completed, cancelled

service_area_idstring · required
dma_idstring · optional
descriptionstring · optional
start_timestring (date-time) · required
end_timestring (date-time) · required
affected_customers_estinteger · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
has_moreboolean · optional
next_cursorstring · optional
curl -X GET "$CONSUMER_API/interruptions" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "sup_2xVSEXVGkjH84PdmebPICxjIkZH",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "title": "Fuga na Rua 3",
      "interruption_type": "maintenance",
      "status": "planned",
      "service_area_id": "ser_23fmkpfkC17kSVJ2spjyiBbOED9",
      "dma_id": "dma_2gE3tiwbLQQnDGcrVkstPO8Bjkg",
      "description": "Leitura confirmada no local.",
      "start_time": "2026-11-19T09:30:00Z",
      "end_time": "2026-11-19T09:30:00Z",
      "affected_customers_est": 1,
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}