Changelogs

This page includes all changes made in release across v3 versions

2025.2

🚧

Preview

This version entered preview on 08/04/2025 available in customer test environments. It will be live the evening of 28/04/2025.

New Endpoints

• POST /v3/applications/{id}/addresses
• POST /v3/occupancies/{id}/holds
• POST /v3/properties/{id}/keys
• POST /v3/repairrequests/{id}/files
• DELETE /v3/properties/{id}/keys/{keyId}
• GET /v3/applications/addresses
• GET /v3/applications/addresses/since
• GET /v3/applications/areas/since
• GET /v3/applications/waitinglists/since
• GET /v3/applications/{id}/waitinglists
• GET /v3/occupancies/holds/since
• GET /v3/occupancies/{id}/holds
• GET /v3/properties/keys/since
• GET /v3/properties/{id}/keys
• PATCH /v3/applications/{id}/addresses/{addressId}
• PATCH /v3/occupancies/{id}/holds/{holdId}
• PATCH /v3/properties/{id}/keys/{keyId}
• PUT /v3/people/{reference}/picture

Endpoint Changes

• GET /v3/properties/periods/since and GET /v3/properties/{id}/periods added optional query parameter of "periodType", this allows you to filter these requests down to specific period types such as void.

2025.1

Breaking Changes

• GET /v3/workorders/elements/since and GET /v3/workorders/{workOrderId}/elements have had the property "data/items/sor/id" removed.

New Endpoints

• POST /v3/cases
• POST /v3/cases/{caseId}/close
• POST /v3/cases/{caseReference}/close
• DELETE /v3/cases/{caseId}
• DELETE /v3/cases/{caseReference}
• GET /v3/properties/adaptations/since
• GET /v3/properties/energy/readings/since
• GET /v3/properties/{propertyId}/adapations
• GET /v3/properties/{propertyId}/energy
• GET /v3/properties/{propertyId}/energy/readings
• PATCH /v3/workorders/{reference}/priority
• PATCH /v3/workorders/{reference}/target

Payload Changes

• SOR Element Response now includes "title", "sor/title", "sor/elementCode", "sor.trade", and "sor/unitOfMeasurement".

2024.6

Breaking Changes

• POST /v3/webhooks now has "developerEmail" property so we can contact you easier about issues, new features and more. This is part of the new Webhook Suspension system.
• Enum Representation has been fixed in v3 and will now display string versions instead of the integer value to match documentation. If you've previously been using ints where an enum was used this will need to be adapted. The system should still accept ints for POST, PATCH, etc endpoints.

New Endpoints

• Attribute Endpoints - We've now included endpoints for managing your attributes.
  • GET /v3/{aggregateName}/attributes/since
  • GET /v3/{aggregateName}/{id}/attributes
  • POST /v3/{aggregateName}/{id}/attributes
  • DELETE /v3/{aggregateName}/{id}/attributes/{attributeAnswerId}
• Files Endpoints - You now have the ability to view, add and download files from the API.
  • GET /v3/{aggregateName}/files/since
  • GET /v3/{aggregateName}/{id}/files
  • POST /v3/{aggregateName}/{id}/files
  • DELETE /v3/{aggregateName}/{id}/files/{attachmentId}
  • GET /v3/{aggregateName}/{id}/files/{attachmentId}/download
• GET /v3/cases/records/since
• GET /v3/cases/{id}/records
• GET /v3/occupancies/addresses/since
• GET /v3/occupancies/{occupancyId}/addresses
• GET /v3/properties/preinspections/since
• GET /v3/properties/{propertyId}/preinspections
• PATCH /v3/webhooks/{subscriptionId}
• GET /v3/workorders/elements/since
• GET /v3/workorders/postinspections/since
• GET /v3/workorders/variations/since
• PATCH /v3/workorders/{reference}/complete
• GET /v3/workorders/{workOrderId}/elements
• GET /v3/workorders/{workOrderId}/postinspections
• GET /v3/workorders/{workOrderId}/variations

Endpoint Changes

• GET /v3/properties added optional query parameter of "lettableOnly", should be provided as a boolean and filters the response to only show unlettable or lettable properties.
• GET /v3/webhooks added optional query parameter of "isActive", should be provided as a boolean and filters the response to only show active or inactive webhook subscriptions.
• All /since endpoints now include an optional query parameter of "to", this is a datetime value like the pre-existing "since" date but can be used to create a range to look at instead of just from a date.

Payload Changes

• Account Alternate Reference Response now includes "type" property which contains the alternate reference type.
• Case Response now has the "summary" property to match the new case summaries feature.
• Property Response now includes "managedBy" and "occupancyCategory" properties.
• Webhook Response now includes optional "suspendedDate" and "suspendedReason" properties as well as required "developerEmail" property.

New Webhook Events

• AttributeAnswerCreated
• AttributeAnswerDeleted
• AttributeAnswerEdited
• CaseLinkedRecordDeleted
• OccupancyCreated