Skip to content
Docs
Select language:English

/api/v1/schedules (GET)

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
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)$/
state
string
Allowed values: upcoming due overdue done
subjectType
string
Allowed values: thing place
q
string
<= 200 characters
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
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)$/
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
name
required
string
everyMonths
required
number | null
everyUnits
required
string | null
meter
required
Any of:
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)$/
label
required
string
unit
required
string
dueOn
required
string | null
leadDays
required
number
leadUnits
required
string | null
anchorOn
required
string
anchorValue
required
string | null
next
required
object
dueOn
required
string | null
dueValue
required
string | null
state
required
string
Allowed values: upcoming due overdue done
basis
required
string
Allowed values: months units both once
snoozedUntil
required
string | null
snoozedUntilValue
required
string | null
skipNext
required
boolean
active
required
boolean
lastService
required
Any of:
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)$/
servicedOn
required
string
rowVersion
required
number
counts
required
object
due
required
number
overdue
required
number
next_cursor
required
string | null
Example
{
  "items": [
    {
      "subject": {
        "type": "thing"
      },
      "next": {
        "state": "upcoming",
        "basis": "months"
      }
    }
  ]
}