Skip to content
Docs
Select language:English

/api/v1/home

GET
/api/v1/home
curl --request GET \
  --url https://example.com/api/v1/home

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
checklist
required
object
dismissed
required
boolean
items
required
Array<object>
object
key
required
string
Allowed values: locationCreated threeThings labelPrinted invited aiConnected installed
done
required
boolean
attention
required
object
toReview
required
integer
>= -9007199254740991 <= 9007199254740991
uncertain
required
integer
>= -9007199254740991 <= 9007199254740991
longUnseen
required
integer
>= -9007199254740991 <= 9007199254740991
unplaced
required
integer
>= -9007199254740991 <= 9007199254740991
overdue
required
integer
>= -9007199254740991 <= 9007199254740991
due
required
integer
>= -9007199254740991 <= 9007199254740991
expiring
required
integer
>= -9007199254740991 <= 9007199254740991
lentOut
required
integer
>= -9007199254740991 <= 9007199254740991
borrowedIn
required
integer
>= -9007199254740991 <= 9007199254740991
lowStock
required
integer
>= -9007199254740991 <= 9007199254740991
agendaBySource
required
object
overdue
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
due
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
expiring
required
object
key
additional properties
integer
>= -9007199254740991 <= 9007199254740991
counts
required
object
inbox
required
integer
>= -9007199254740991 <= 9007199254740991
unprintedLabels
required
integer
>= -9007199254740991 <= 9007199254740991
locations
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingCount
required
integer
>= -9007199254740991 <= 9007199254740991
unplacedCount
required
integer
>= -9007199254740991 <= 9007199254740991
meteredThings
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "checklist": {
    "items": [
      {
        "key": "locationCreated"
      }
    ]
  }
}