Skip to content
Docs
Select language:English

/api/v1/agenda

GET
/api/v1/agenda
curl --request GET \
  --url 'https://example.com/api/v1/agenda?limit=20&state=due' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters
state
string
Allowed values: due overdue expiring upcoming
sourceType
Any of:
string
locationId
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)$/
from
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
to
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
key
required
string
sourceType
required
string
Allowed values: schedule warranty registration document loan thing_expiry reading_stale stock
sourceId
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)$/
kind
required
string
Allowed values: due overdue expiring
state
required
string
Allowed values: upcoming due overdue expiring expired
locationId
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)$/
subject
required
object
type
required
string
Allowed values: thing place location
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
path
required
string
shortCode
string | null
title
required
string
dueOn
required
string | null
dueValue
required
string | null
unit
required
string | null
actions
required
Array<string>
Allowed values: complete snooze mark_returned renew open
counts
required
object
overdue
required
integer
>= -9007199254740991 <= 9007199254740991
due
required
integer
>= -9007199254740991 <= 9007199254740991
expiring
required
integer
>= -9007199254740991 <= 9007199254740991
next_cursor
required
string | null
Example
{
  "items": [
    {
      "sourceType": "schedule",
      "kind": "due",
      "state": "upcoming",
      "subject": {
        "type": "thing"
      },
      "actions": [
        "complete"
      ]
    }
  ]
}