Skip to main content
GET
Works programme

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
description
string
required
status
enum<string>
required
Available options:
planning,
in_progress,
complete,
cancelled
contractorContactId
string | null
required
contractorName
string | null
required
quotesReceived
required
contractorDecisionBy
string | null
required
startsOn
string
required
endsOn
string
required
completedOn
string | null
required
properties
required
propertiesDone
required
budgetMinor
required
spentMinor
required
committedMinor
required
leftMinor
required
awaitingApproval
required
landlordApprovalAboveMinor
required
budgetLineId
string | null
required
followOnCycleId
string | null
required
followOnDueOn
string | null
required
nextAction
object
required
nextActionLabel
string | null
required
revision
required
createdAt
string
required
updatedAt
string
required
jobs
object[]
required