API Reference
Start typing to search…

2025.5

🚧

This release goes live the evening of the 27th October 2025

New Endpoints

  • GET /v3/applications/{id}/can-reconfirm
  • GET /v3/applications/{id}/offers
  • PATCH /v3/applications/{id}/offers/{offerId}/accept
  • PATCH /v3/applications/{id}/offers/{offerId}/decline
  • PATCH /v3/applications/{id}/reconfirm
  • GET /v3/applications/{reference}/events
  • POST /v3/cases/{id}/feedback
  • POST /v3/cases/{id}/records
  • GET /v3/cases/{reference}/events
  • POST /v3/cases/{reference}/feedback
  • POST /v3/cases/{reference}/records
  • GET /v3/cases/{reference}/stages
  • GET /v3/occupancies/{id}/upcoming-visits
  • GET /v3/occupancies/{reference}/events
  • GET /v3/occupancies/{reference}/visits
  • POST /v3/occupancies/{reference}/visits
  • GET /v3/occupancies/{reference}/visits/{visitId}
  • PATCH /v3/occupancies/{reference}/visits/{visitId}
  • PATCH /v3/occupancies/{reference}/visits/{visitId}/cancel
  • PATCH /v3/occupancies/{reference}/visits/{visitId}/complete
  • GET /v3/people/{id}/requirements
  • POST /v3/people/{id}/requirements
  • DELETE /v3/people/{id}/requirements/{requirementId}
  • PATCH /v3/people/{id}/requirements/{requirementId}
  • GET /v3/people/{id}/tags
  • POST /v3/people/{id}/tags
  • DELETE /v3/people/{id}/tags/{tagId}
  • GET /v3/people/{id}/welfare-checks
  • POST /v3/people/{id}/welfare-checks
  • PATCH /v3/people/{id}/welfare-checks/{welfareCheckId}/cancel
  • PATCH /v3/people/{id}/welfare-checks/{welfareCheckId}/close
  • PATCH /v3/people/{id}/welfare-checks/{welfareCheckId}/welfare-records/{welfareRecordId}
  • GET /v3/people/{id}/welfare-checks/{welfarecheckId}
  • DELETE /v3/people/{personId}/contacts/{contactId}
  • GET /v3/people/{personId}/contacts/{contactId}
  • PATCH /v3/people/{personId}/renew
  • GET /v3/people/{reference}/events
  • POST /v3/properties
  • DELETE /v3/properties/{id}
  • PATCH /v3/properties/{id}
  • PATCH /v3/properties/{id}/grouping
  • GET /v3/properties/{id}/keys/{keyId}
  • PATCH /v3/properties/{id}/toggle-suppress-cbl
  • PATCH /v3/properties/{id}/toggle-suppress-repairs
  • PATCH /v3/properties/{id}/uprn
  • PATCH /v3/properties/{id}/valuation
  • PATCH /v3/repairrequests/{reference}/{repairRequestId}/cancel
  • GET /v3/tasks/{reference}/events
  • PATCH /v3/workorders/{id}
  • PATCH /v3/workorders/{id}/amend-complete
  • POST /v3/workorders/{id}/approve
  • POST /v3/workorders/{id}/cancel
  • PATCH /v3/workorders/{id}/complete
  • PATCH /v3/workorders/{id}/contactdetails
  • PATCH /v3/workorders/{id}/contractor
  • POST /v3/workorders/{id}/feedback
  • POST /v3/workorders/{id}/holds
  • PATCH /v3/workorders/{id}/invoice
  • PATCH /v3/workorders/{id}/owner
  • PATCH /v3/workorders/{id}/priority
  • PATCH /v3/workorders/{id}/reinstate
  • PATCH /v3/workorders/{id}/reported
  • PATCH /v3/workorders/{id}/right-first-time
  • PATCH /v3/workorders/{id}/target
  • POST /v3/workorders/{id}/unhold
  • PATCH /v3/workorders/{id}/vat
  • GET /v3/workorders/{id}/visits
  • PATCH /v3/workorders/{reference}/amend-complete
  • PATCH /v3/workorders/{reference}/contractor
  • GET /v3/workorders/{reference}/events
  • POST /v3/workorders/{reference}/feedback
  • GET /v3/workorders/{reference}/financials
  • POST /v3/workorders/{reference}/financials
  • GET /v3/workorders/{reference}/financials/{financialId}
  • PATCH /v3/workorders/{reference}/financials/{financialId}
  • POST /v3/workorders/{reference}/financials/{financialId}/split
  • PATCH /v3/workorders/{reference}/invoice
  • GET /v3/workorders/{reference}/linked
  • POST /v3/workorders/{reference}/linked
  • GET /v3/workorders/{reference}/linked/{workOrderId}
  • PATCH /v3/workorders/{reference}/owner
  • POST /v3/workorders/{reference}/postinspections
  • GET /v3/workorders/{reference}/postinspections/{postInspectionId}
  • PATCH /v3/workorders/{reference}/postinspections/{postInspectionId}/cancel
  • PATCH /v3/workorders/{reference}/postinspections/{postInspectionId}/fail
  • PATCH /v3/workorders/{reference}/postinspections/{postInspectionId}/pass
  • PATCH /v3/workorders/{reference}/postinspections/{postInspectionId}/reassign
  • PATCH /v3/workorders/{reference}/postinspections/{postInspectionId}/resubmit
  • PATCH /v3/workorders/{reference}/reinstate
  • PATCH /v3/workorders/{reference}/reported
  • PATCH /v3/workorders/{reference}/right-first-time
  • POST /v3/workorders/{reference}/unhold
  • PATCH /v3/workorders/{reference}/vat
  • GET /v3/workorders/{reference}/visits
  • POST /v3/workorders/{reference}/visits
  • GET /v3/workorders/{reference}/visits/{visitId}
  • PATCH /v3/workorders/{reference}/visits/{visitId}
  • PATCH /v3/workorders/{reference}/visits/{visitId}/complete
  • POST /v3/workorders/{workOrderId}/variations
  • GET /v3/workorders/{workOrderId}/variations/{variationId}
  • PATCH /v3/workorders/{workOrderId}/variations/{variationId}/authorise

Endpoint Changes

  • /v3/applications

    • PATCH /v3/applications/reconfirm/{reference} — removed without deprecation ⚠️

  • /v3/cases

    • GET /v3/cases — added optional query parameter rateOnly

  • /v3/occupancies

    • GET /v3/occupancies — added optional query parameters caseCategory, onlyOpen, rateOnly
    • GET /v3/occupancies/{id}/cases — added optional query parameter rateOnly
    • GET /v3/occupancies/{id}/repairs — added enum value AppointmentConfirmed and optional query parameters activeOnly, caseCategory, rateOnly, startedAfter
    • GET /v3/occupancies/{occupancyId}/occupants — added optional query parameter activeOnly
    • GET /v3/occupancies/{uorn}/cases — added optional query parameters and response properties

  • /v3/people

    • GET /v3/people — added optional response property data/items/lastContactRenewedDate
    • GET /v3/people/since — added optional response property data/items/lastContactRenewedDate
    • GET /v3/people/{id} — added optional response property data/lastContactRenewedDate
    • PATCH /v3/people/{id} — added optional response property data/lastContactRenewedDate
    • PATCH /v3/people/{id}/nationalinsurance — added optional response property data/lastContactRenewedDate
    • GET /v3/people/{id}/properties — added required response property data/items/chargeCycle
    • GET /v3/people/{personRef}/cases — added optional query parameter activeOnly and response properties
    • GET /v3/people/{reference} — added optional response property data/lastContactRenewedDate
    • PUT /v3/people/{reference}/picture — added optional response property data/lastContactRenewedDate

  • /v3/properties

    • GET /v3/properties — added required response property data/items/isSuppressingCbl
    • GET /v3/properties/charges/since — added optional query parameter activeOnly
    • GET /v3/properties/since — added required response property data/items/isSuppressingCbl
    • GET /v3/properties/{id} — added required response property data/isSuppressingCbl
    • GET /v3/properties/{propertyId}/charges — added optional query parameter activeOnly
    • GET /v3/properties/{uprn} — added required response property data/isSuppressingCbl

  • /v3/workorders

    • GET /v3/workorders — added required response property data/items/slippageReason
    • POST /v3/workorders — added new request property useAutoFinancialCodes and required response property data/slippageReason
    • GET /v3/workorders/since — added required response property data/items/slippageReason
    • GET /v3/workorders/{id} — added required response property data/slippageReason
    • GET /v3/workorders/{reference} — added required response property data/slippageReason
    • PATCH /v3/workorders/{reference} — added required response property data/slippageReason