Qodex.ai

List Devices behind a Gateway

GET {{baseUrl}}/devices/:deviceId/devices?include=<string>&page[limit]=20&page[cursor]=<string>&filter[modelName]=<string>&filter[serialNumber]=<string>&filter[profile.name]=<string>&filter[profile.notes]=<string>&filter[hasLocation.data.id]=<string>

List of Devices behind a Gateway

Request Params

KeyDatatypeRequiredDescription
includestringInclude the provided feature (comma separated)
page[limit]numberMaximum number of items to return in a single page
page[cursor]stringCursor representing which page to fetch
filter[modelName]stringFilter by device model name. The filter matches substrings.
filter[serialNumber]stringFilter by device serial number. The filter matches substrings.
filter[profile.name]stringFilter by device profile name. The filter matches substrings.
filter[profile.notes]stringFilter by device profile notes. The filter matches substrings.
filter[hasLocation.data.id]stringFilter by location id. The filter matches substrings.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices&quot;,&quot;next&quot;:&quot;/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices?page[cursor]=qwerty&quot;},&quot;data&quot;:[{&quot;type&quot;:&quot;Device&quot;,&quot;id&quot;:&quot;1bcaafc3-d4d3-43e1-ab64-89d8518d5951&quot;,&quot;attributes&quot;:{&quot;modelName&quot;:&quot;MSIB CCA&quot;,&quot;serialNumber&quot;:&quot;L7955828&quot;,&quot;profile&quot;:{&quot;name&quot;:&quot;X300-5&quot;,&quot;notes&quot;:&quot;In basement, ask Bruno for key&quot;}},&quot;relationships&quot;:{&quot;hasGateway&quot;:{&quot;data&quot;:{&quot;type&quot;:&quot;aute&quot;,&quot;id&quot;:&quot;1bcaafc3-d4d3-43e1-ab64-89d8518d5951&quot;}},&quot;hasLocation&quot;:{&quot;data&quot;:{&quot;type&quot;:&quot;veniam cillum proident&quot;,&quot;id&quot;:&quot;598a0329-2cca-4227-aea5-629862864cdf&quot;}},&quot;hasFeatures&quot;:{&quot;data&quot;:{}}}},{&quot;type&quot;:&quot;Device&quot;,&quot;id&quot;:&quot;1bcaafc3-d4d3-43e1-ab64-89d8518d5951&quot;,&quot;attributes&quot;:{&quot;modelName&quot;:&quot;MSIB CCA&quot;,&quot;serialNumber&quot;:&quot;L7955828&quot;,&quot;profile&quot;:{&quot;name&quot;:&quot;X300-5&quot;,&quot;notes&quot;:&quot;In basement, ask Bruno for key&quot;}},&quot;relationships&quot;:{&quot;hasGateway&quot;:{&quot;data&quot;:{&quot;type&quot;:&quot;enim ullamc&quot;,&quot;id&quot;:&quot;1bcaafc3-d4d3-43e1-ab64-89d8518d5951&quot;}},&quot;hasLocation&quot;:{&quot;data&quot;:{&quot;type&quot;:&quot;non voluptate&quot;,&quot;id&quot;:&quot;598a0329-2cca-4227-aea5-629862864cdf&quot;}},&quot;hasFeatures&quot;:{&quot;data&quot;:{}}}}],&quot;included&quot;:[{&quot;id&quot;:&quot;e7c6d033-c305-410a-a248-f7a1e6289841&quot;,&quot;type&quot;:&quot;DeviceInfo&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;Bob&#39;s device&quot;,&quot;description&quot;:&quot;Don not power off&quot;,&quot;timezone&quot;:&quot;Europe/Zurich&quot;},&quot;relationships&quot;:{&quot;hasDevice&quot;:{&quot;data&quot;:{&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}}},{&quot;id&quot;:&quot;e7c6d033-c305-410a-a248-f7a1e6289841&quot;,&quot;type&quot;:&quot;DeviceInfo&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;Bob&#39;s device&quot;,&quot;description&quot;:&quot;Don not power off&quot;,&quot;timezone&quot;:&quot;Europe/Zurich&quot;},&quot;relationships&quot;:{&quot;hasDevice&quot;:{&quot;data&quot;:{&quot;id&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}}}}]}