Jump to Content
API Reference
v1.0
v2.0
v3.0
API Reference
SLC
API Reference
Forum
Search
JUMP TO
Documentation
Welcome
Rate Limiting
Obtaining your API Token
Making your first request
Controller and User Data Objects
Smart Hose Timer Data Objects
Smart Lighting Controller Data Objects
Properties (Homes)
Postman
Controller and user
PersonService
/public/person/info
get
/public/person/:id
get
DeviceService
/public/device/:id
get
/public/device/:id/current_schedule
get
/public/device/:id/event?startTime=:startTime&endTime=:endTime
get
/public/device/:id/forecast?units=:units
get
/public/device/stop_water
put
/public/device/rain_delay
put
/public/device/on
put
/public/device/off
put
/public/device/pause_zone_run
put
/public/device/resume_zone_run
put
ZoneService
/public/zone/:id
get
/public/zone/start
put
/public/zone/start_multiple
put
/public/zone/setMoistureLevel
put
/public/zone/setMoisturePercent
put
/public/zone/enable
put
/public/zone/disable
put
ScheduleRuleService
/public/schedulerule/:id
get
/public/schedulerule/skip
put
/public/schedulerule/start
put
/public/schedulerule/seasonal_adjustment
put
/public/schedulerule/skip_forward_zone_run
put
FlexScheduleRuleService
/public/flexschedulerule/:id
get
NotificationService
/public/notification/webhook_event_type
get
/public/notification/:deviceId/webhook
get
/public/notification/webhook/:id
get
/public/notification/webhook
put
/public/notification/webhook/:id
delete
/public/notification/webhook
post
Webhook types and sample JSON
Webhook basic authentication
Smart Hose Timer
ProgramService
/program/createSkipOverrides
post
/program/deleteProgram/{id}
delete
/program/deleteSkipOverrides
post
/program/getProgram/{id}
get
/program/listPrograms/{entityId}
get
/program/createProgramV2
post
/program/getProgramV2/{id}
get
/program/listProgramsV2
get
/program/updateProgramV2
put
/program/createPlannedRunSkipOverrides
post
/program/deletePlannedRunSkipOverrides
post
SummaryService
/summary/getValveDayViews
post
ValveService
/valve/getBaseStation/{id}
get
/valve/getValve/{id}
get
/valve/listBaseStations/{userId}
get
/valve/listValves/{baseStationId}
get
/valve/setDefaultRuntime
put
/valve/startWatering
put
/valve/stopWatering
put
Smart Lighting Controller
LightingService
/lighting/listLightingAreas/{user_id}
get
/lighting/getLightingArea/{id}
get
/lighting/listLightingControllers/{lighting_area_id}
get
/lighting/getLightingController/{id}
get
/lighting/updateLightingController
put
/lighting/listLightingZones
get
/lighting/getLightingZone/{id}
get
/lighting/updateLightingZone
put
/lighting/setLightingZoneStates
put
/lighting/setLightingZoneDimmingLevels
put
/lighting/setLightingZoneDesiredDimmingSettings
put
/lighting/createLightingZoneGroup
post
/lighting/listLightingZoneGroups/{lighting_area_id}
get
/lighting/getLightingZoneGroup/{id}
get
/lighting/updateLightingZoneGroup
put
/lighting/deleteLightingZoneGroup/{id}
delete
/lighting/createLightingScene
post
/lighting/listLightingScenes/{lighting_area_id}
get
/lighting/getLightingScene/{id}
get
/lighting/updateLightingScene
put
/lighting/deleteLightingScene/{id}
delete
/lighting/activateLightingScene/{id}
put
/lighting/deactivateLightingScene/{id}
put
/lighting/createLightingProgram
post
/lighting/listLightingPrograms
get
/lighting/getLightingProgram/{id}
get
/lighting/updateLightingProgram
put
/lighting/deleteLightingProgram/{id}
delete
Webhooks
WebhookService
Webhooks info
/webhook/createWebhook
post
/webhook/getWebhook/{id}
get
/webhook/listWebhooks
get
/webhook/updateWebhook
put
/webhook/deleteWebhook/{id}
delete
/webhook/deleteAllWebhooks
delete
/webhook/listWebhookEventTypes
get
Property Service
PropertyService
/property/getProperty/{id}
get
/property/listProperties/{userId}
get
/property/findPropertyByEntity
get
Support
Forum
Powered by
Forum
If you have any questions or feedback you can get support in our
public API support forum
.
