Skip to main content
GET
Cycle

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Response

Success

id
string
required
name
string
required
category
enum<string>
required
Available options:
servicing,
building_fabric,
communal
status
enum<string>
required
Available options:
active,
ended
templateId
string
required
recurrenceInterval
required
recurrenceUnit
enum<string>
required
Available options:
day,
week,
month,
quarter,
year
anchorMonth
required
anchorDay
required
repeatsLabel
string
required
properties
required
nextRunOn
string | null
required
overdue
required
dueThisMonth
required
accessIssues
required
nextBatch
object | null
required
contractorContactId
string | null
required
contractorName
string | null
required
perJobMinor
required
autoRaise
boolean
required
autoRaiseSetAt
string | null
required
rules
object
required
budgetLineId
string | null
required
notes
string | null
required
revision
required
createdAt
string
required
updatedAt
string
required
targets
object[]
required
runs
object[]
required