Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

devices

List devices

get/app/v1/devices

Query parameters

status'active' | 'archived'

Device status

type_idstring

Device type

facility_idstring uuid

Facility ID

device_namestring

Search for devices with a name containing this string

namestring

String to search for in facility names

page_sizenumber

page size

pagenumber

page number

sort_by'facility_name' | 'name'

sort by

sort_direction'asc' | 'desc'

sort direction

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "attributes": {
        "height": 10,
        "location": [
          43.65107,
          -79.347015
        ],
        "provider": "provider"
      },
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      },
      "facility": {
        "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
        "name": "Facility 1"
      },
      "measurement_types": [
        "volume"
      ]
    }
  ]
}