/api/v1/home/overview
GET
/api/v1/home/overview
const url = 'https://example.com/api/v1/home/overview';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/home/overviewResponses
Section titled “Responses”Default Response
Media typeapplication/json
object
locations
required
Array<object>
object
id
required
string format: uuid
places
required
integer
flags
required
object
overdue
required
integer
due
required
integer
expiring
required
integer
lentOut
required
integer
uncertain
required
integer
lowStock
required
integer
value
object
things
required
integer
valued
required
integer
byCurrency
required
Array<object>
object
currency
required
string
amount
required
string
moneyHidden
boolean
top
required
object
overdue
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
due
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
expiring
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
lentOut
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
borrowedIn
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
uncertain
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
longUnseen
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
lowStock
object
name
required
string | null
locationId
required
string format: uuid
dueOn
string | null
person
string | null
quantity
string
minimum
string
lastSeenAt
string
insights
required
Any of:
object
thisYear
required
integer
years
required
Array<object>
object
year
required
integer
soFar
required
boolean
byCurrency
required
Array<object>
object
currency
required
string
amount
required
string
value
required
object
things
required
integer
valued
required
integer
byCurrency
required
Array<object>
object
currency
required
string
amount
required
string
included
required
Array<string>
hiddenIn
required
Array<string>
moneyOff
required
Array<string>
null
Example
{ "locations": [ { "moneyHidden": true } ]}