Rules

List Rules

Return a list of Rules contained in a specified location.

get/rules

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesr:rules:*
TypeScript
https://skmtc.dev/smartthings/apis/smartthings-api/docs/rules/get.ts
A function with typed inputs. Its response is checked against the schema.

locationIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The ID of the Location you want to list Rules for.

includeAllParentsstring

If set to true, all rules are returned

maxinteger

The max number of Rules to fetch

offsetinteger

The start index of Rules to fetch

A paginated list of Rules.

Nov 27, 2023e8dd260a33ec Revision changes
- info
  added the new optional query request parameter includeAllParents