List Devices
GET {{baseUrl}}/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 Devices
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | string | Include the provided feature (comma separated) | |
page[limit] | number | Maximum number of items to return in a single page | |
page[cursor] | string | Cursor representing which page to fetch | |
filter[modelName] | string | Filter by device model name. The filter matches substrings. | |
filter[serialNumber] | string | Filter by device serial number. The filter matches substrings. | |
filter[profile.name] | string | Filter by device profile name. The filter matches substrings. | |
filter[profile.notes] | string | Filter by device profile notes. The filter matches substrings. | |
filter[hasLocation.data.id] | string | Filter by location id. The filter matches substrings. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"self":"/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices","next":"/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices?page[cursor]=qwerty"},"data":[{"type":"Device","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951","attributes":{"modelName":"MSIB CCA","serialNumber":"L7955828","profile":{"name":"X300-5","notes":"In basement, ask Bruno for key"}},"relationships":{"hasGateway":{"data":{"type":"reprehenderit dolor","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951"}},"hasLocation":{"data":{"type":"quis consequat nostrud anim","id":"598a0329-2cca-4227-aea5-629862864cdf"}},"hasFeatures":{"data":{}}}},{"type":"Device","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951","attributes":{"modelName":"MSIB CCA","serialNumber":"L7955828","profile":{"name":"X300-5","notes":"In basement, ask Bruno for key"}},"relationships":{"hasGateway":{"data":{"type":"pariatur sed enim consequat","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951"}},"hasLocation":{"data":{"type":"culpa laboris officia veniam","id":"598a0329-2cca-4227-aea5-629862864cdf"}},"hasFeatures":{"data":{}}}}],"included":[{"id":"e7c6d033-c305-410a-a248-f7a1e6289841","type":"DeviceInfo","attributes":{"name":"Bob's device","description":"Don not power off","timezone":"Europe/Zurich"},"relationships":{"hasDevice":{"data":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}},{"id":"e7c6d033-c305-410a-a248-f7a1e6289841","type":"DeviceInfo","attributes":{"name":"Bob's device","description":"Don not power off","timezone":"Europe/Zurich"},"relationships":{"hasDevice":{"data":{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}}}]}