Skip to content
Docs
Select language:English

/api/v1/summary

GET
/api/v1/summary
curl --request GET \
  --url https://example.com/api/v1/summary \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
asOf
required
string
totals
required
object
things
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
uncertain
required
integer
>= -9007199254740991 <= 9007199254740991
longUnseen
required
integer
>= -9007199254740991 <= 9007199254740991
lowStock
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)$/
name
required
string
kind
required
string
timeZone
required
string
counts
required
object
things
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
Any of:
integer
>= -9007199254740991 <= 9007199254740991
borrowedIn
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
uncertain
required
integer
>= -9007199254740991 <= 9007199254740991
longUnseen
required
integer
>= -9007199254740991 <= 9007199254740991
lowStock
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
Examplegenerated
{
  "asOf": "example",
  "totals": {
    "things": 1,
    "unplaced": 1,
    "overdue": 1,
    "due": 1,
    "expiring": 1,
    "lentOut": 1,
    "borrowedIn": 1,
    "uncertain": 1,
    "longUnseen": 1,
    "lowStock": 1
  },
  "locations": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "kind": "example",
      "timeZone": "example",
      "counts": {
        "things": 1,
        "unplaced": 1,
        "overdue": 1,
        "due": 1,
        "expiring": 1,
        "lentOut": 1,
        "borrowedIn": 1,
        "uncertain": 1,
        "longUnseen": 1,
        "lowStock": 1
      }
    }
  ]
}