Jump to Content
API Reference
v1.0
v2.3
v3.0
Log In
API Reference
Log In
v3.0
API Reference
Data Types / Handling
All
Pages
Start typing to search…
JUMP TO
Getting Started
Welcome
Authentication
Data Types / Handling
Webhooks
Changelogs
2026.1
2025.6
2025.5
2025.3
2025.2
2025.1
2024.6
Rubixx Housing API
Accounts
Create/Activate Alternate Reference
post
Paginated Account Alternate References
get
Deactivate Alternate Reference
del
Paginated Arrangements
get
Create Arrears Stage
post
End Active Arrears Stage
del
Paginated Arrears Stages
get
Progress Active Arrears Stage
post
Paginated Arrears Stage Notes
get
Paginated Account Transactions
get
Applications
Get EForms By Application Reference
get
Get All Application eForms for Submission
get
Returns existing submissions for an Application eForm
get
Get eForm Fields for Submission.
get
Submits a completed eForm for the specified entity and eForm definition.
post
Retrieves a paginated list of issued eForms associated with the specified entity.
get
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Add Attribute To Application
post
Paginated Application Attributes
get
Updates the answer to a specific attribute question for the aggregate entity identified by the specified ID.
patch
Delete Attribute From Application
del
Paginated Applicants
get
Get Applications By Id
get
Get Applications By Reference
get
Paginated Applications
get
Paginated Applications' Previous Address List
get
Create new Previous Address for given Application
post
Update Previous Address for given Application
patch
Paginated Application Waiting Lists
get
Applications' Area Updated Since
get
Check Can Re-Confirm The Application by Id
get
Reconfirm Review / Application by Id
patch
Get Application Offers by Reference
get
Get Application Offers by Id
get
Accept an Offer by Reference
patch
Accept an Offer by Id
patch
Decline an Offer by Reference
patch
Decline an Offer by Id
patch
Add Event To Application
post
Get Events By Id On Application
get
Get Events By Reference On Application
get
Upload File To Application
post
Paginated Application Files
get
Download File From Application
get
Delete File From Application
del
Add Note To Application
post
Get Applications By Id On Property
get
Add Risk To Application
post
Get Risks By Id On Application
get
Update Risk On Application
patch
Reset Risk Score On Application
patch
Add risk by Application Reference to application
post
Get risk on appilcation by Application Reference
get
Update risk on application by Application Reference and risk name
patch
Get risk on application by Application Reference and risk name
get
Reset risk on application by Application Reference and risk name
post
End risk on application by Application Reference and risk name
post
Retrieves a paginated list of core attributes associated with the specified entity.
get
Auth
OAuth Resource Password Owner Flow
post
OAuth Refresh Token
post
Cases
Get EForms By Case Reference
get
Retrieves a paginated list of issued eForms associated with the specified entity.
get
Retrieves a paginated list of issued eForm submissions for the specified customer and eForm.
get
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Retrieves the specified electronic form (eForm) for submission by the current user.
get
Submits a completed eForm for the specified entity and eForm definition.
post
Add Attribute To Case
post
Paginated Case Attributes
get
Updates the answer to a specific attribute question for the aggregate entity identified by the specified ID.
patch
Delete Attribute From Case
del
Get Case By Id
get
Get Case By Reference
get
Paginated Cases
get
Create a Case
post
Cancel a Case by Case Id
del
Cancel a Case by Case Reference
del
Close a Case by Case Id
post
Close a Case by Case Reference
post
Submit Case Feedback by Reference
post
Submit Case Feedback by Id
post
Paginated Case Records
get
Create Case Linked Records by Id
post
Create Case Linked Records by Reference
post
Paginated Case Stages by Reference
get
Paginated Case Stages by Id
get
Add Event To Case
post
Get Events By Id On Case
get
Get Events By Reference On Case
get
Add Note To Case
post
Get Cases By Id On Property
get
Add Risk To Case
post
Get Risks By Id On Case
get
Update Risk On Case
patch
Reset Risk Score On Case
patch
Add risk by Case Reference to case
post
Get risk on case by Case Reference
get
Update risk on case by Case Reference and risk name
patch
Get risk on case by Case Reference and risk name
get
Reset risk on case by Case Reference and risk name
post
End risk on case by Case Reference and risk name
post
Retrieves a paginated list of core attributes associated with the specified entity.
get
Reassign a Case by Case Id
patch
Reassign a Case by Case Reference
patch
Retarget a Case by Case Id
patch
Retarget a Case by Case Reference
patch
Reprioritise a Case by Case Id
patch
Reprioritise a Case by Case Reference
patch
Recategorise a Case by Case Id
patch
Recategorise a Case by Case Reference
patch
Update a Case Description by Case Id
patch
Update a Case Description by Case Reference
patch
Check if any Cases Require Feedback for an Occupancy
get
Occupancies
Add Attribute To Occupancy
post
Paginated Occupancy Attributes
get
Updates the answer to a specific attribute question for the aggregate entity identified by the specified ID.
patch
Delete Attribute From Occupancy
del
Paginated Bypass Addresses
get
Get Related Cases By Occupancy Reference
get
Get Paginated Occupancy Cases
get
Get Occupancy By Id
get
Get Occupancy By Uorn
get
Paginated Occupancies
get
Paginated Occupancy Arrears Holds
get
Create Occupancy Arrears Hold
post
Edit Occupancy Arrears Hold
patch
Paginated Technical Benefits Received By Occupancies
get
Get Occupancy Accounts
get
Get Occupancy Account Transactions
get
Get Occupancy Account By Id
get
Get Paginated Occupancy Repairs
get
Get Occupancy Repair
get
Cancel Visit/Appointment
patch
Paginated Occupants
get
Add Event To Occupancy
post
Get Events By Id On Occupancy
get
Get Events By Reference On Occupancy
get
Upload File To Occupancy
post
Paginated Occupancy Files
get
Download File From Occupancy
get
Delete File From Occupancy
del
Add Note To Occupancy
post
Get Occupancies By Id On Property
get
Add Risk To Occupancy
post
Get Risks By Id On Occupancy
get
Update Risk On Occupancy
patch
Reset Risk Score On Occupancy
patch
Add risk by UORN to occupancy
post
Get risk on occupancy by UORN
get
Update risk on occupancy by UORN and risk name
patch
Get risk on occupancies by UORN and risk name
get
Reset risk on occupancy by UORN and risk name
post
End risk on occupancy by UORN and risk name
post
Get Paginated Occupancy Visits by Reference
get
Create Occupancy Visit
post
Get Paginated Occupancy Visits by Id
get
Get Occupancy Visit
get
Update Occupancy Visit
patch
Complete Occupancy Visit
patch
Get Upcoming Visits by Occupancy Id
get
Get EForms By UORN
get
Get All Occupancies eForms for Submission
get
Returns existing submissions for an Occupancy eForm
get
Get eForm Fields for an Occupancy IssuedEForm.
get
Submits a completed eForm for the specified entity and eForm definition.
post
Retrieves a paginated list of issued eForms associated with the specified entity.
get
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Retrieves a paginated list of core attributes associated with the specified entity.
get
People
Add Attribute To Person
post
Update Person Attribute
patch
Paginated Person Attributes
get
Delete Attribute Answer
del
Get Person Applications
get
Get Person Draft Applications
get
Get related cases by person reference
get
Paginated Person Contacts
get
Create Person Contact
post
Update Person Contacts
patch
Get a Person Contact
get
Remove a Person Contact
del
Renew Person Contacts / Allow Digital Delivery on Current Occupancy
patch
Get Person By Id
get
Update Person Details
patch
Get Person By Reference
get
Get Person's Picture By Id
get
Get Person's Picture By Reference
get
Update Person Picture
put
Paginated People
get
Updates the National Insurance Number for the specified person.
patch
Marks the specified person as deceased
post
Get Paginated Person Chats
get
Create Chat
post
Get Person Chat Messages
get
Create Message
post
Close Chat
patch
Creates a new next of kin entry for the specified person.
post
Removes the next of kin association for the specified person.
del
Reconfirms the next of kin information for the specified person.
post
Paginated Person Notifications
get
Mark Noifications as Read
patch
Get Person Properties
get
Get Paginated Person Requirements
get
Create Person Requirement
post
Edit Person Requirement
patch
Remove Person Requirement
del
Complete Welfare Check Record
patch
Get Paginated Welfare Checks
get
Create Welfare Check Control
post
Get Welfare Check Control by Id
get
Close Welfare Check Control
patch
Cancel Welfare Check Control
patch
Add Event To Person
post
Get Events By Id On Person
get
Get Events By Reference On Person
get
Upload File To Person
post
Paginated Person Files
get
Download File From Person
get
Delete File From Person
del
Add Risk To Person
post
Get Risks By Id On Person
get
Update Risk On Person
patch
Reset Risk Score On Person
patch
Add risk by Person Reference to person
post
Get risk on person by person reference
get
Update risk on person by Person Reference and risk name
patch
Get risk on person by Person Reference and risk name
get
Reset risk on person by Person Reference and risk name
post
End risk on person by Person Reference and risk name
post
Get Paginated People's Tags
get
Add Tag To a Person
post
Remove Tag From a Person
del
Retrieves a paginated list of core attributes associated with the specified entity.
get
Verifies whether a provided NI Number is already in use by a Person in the system
get
Properties
Add Attribute To Property
post
Paginated Property Attributes
get
Updates the answer to a specific attribute question for the aggregate entity identified by the specified ID.
patch
Delete Attribute From Property
del
Paginated Property Adaptations
get
Paginated Property Asbestos
get
Paginated Property Charges
get
Get Property By Id
get
Dispose Property
del
Edit Property Details
patch
Get Property By Uprn
get
Paginated Properties
get
/v3/properties
post
Change Property UPRN
patch
Edit Property Grouping
patch
Update Property Valuation
patch
Suppress Property CBL
patch
Suppress Property Repairs
patch
Property Energy Readings
get
Property EPC Record
get
Paginated Property Officers
get
Paginated Property Ownership
get
Paginated Property Periods
get
Paginated Pre-Inspections
get
Paginated Property Roles
get
Get EForms By UPRN
get
Retrieves a paginated list of issued eForms associated with the specified entity.
get
Retrieves a paginated list of issued eForm submissions for the specified customer and eForm.
get
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Retrieves the specified electronic form (eForm) for submission by the current user.
get
Submits a completed eForm for the specified entity and eForm definition.
post
Add Event To Property
post
Get Events By Id On Property
get
Get Events By Reference On Property
get
Upload File To Property
post
Paginated Property Files
get
Download File From Property
get
Delete File From Property
del
Get Property Key Sets By Property Id
get
Add Property Key Set
post
Edit Property Key Set
patch
Delete Property Key Set
del
Get Property Key Set By Key Id
get
Add Note To Property
post
Get Notes By Id On Property
get
Add Risk To Property
post
Get Risks By Id On Property
get
Update Risk On Property
patch
Reset Risk Score On Property
patch
Add risk by UPRN to property
post
Get risk on property by UPRN
get
Update risk on property by UPRN and risk name
patch
Get risk on property by UPRN and risk name
get
Reset risk on property by UPRN and risk name
post
End risk on property by UPRN and risk name
post
Retrieves a paginated list of core attributes associated with the specified entity.
get
Add Asbestos into Property
post
Paginated Property Asbestos Surveys
get
Paginated Property Asbestos Samples
get
Add Survey into Property Asbestos
post
Add Sample into Property Asbestos
post
View an Asbestos
get
Edit Asbestos Details
patch
View an Asbestos Survey
get
Edit a Asbestos Survey
patch
View an Asbestos Sample
get
Edit a Asbestos Sample
patch
Set Removed For an Asbestos
patch
Paginated Asbestos Files
get
Add Files into Asbestos
post
Edit Asbestos File
patch
Delete Asbestos File
del
Download Asbestos File
get
/v3/properties/{propertyId}/components
get
/v3/properties/{uprn}/components
get
Edit Property Disposal Details
patch
Reinstate a Property
patch
Remove Pre Allocations
del
Get Property's Block Properties
get
Get Property CBL Details
get
Amend Property CBL Details
patch
Paginated Property Grants by Property Id
get
Create a Property Grant By Property Id
post
Paginated Property Grants by UPRN
get
Create a Property Grant By UPRN
post
View a Property Grant by Property Id
get
Delete a Property Grant by Property Id
del
Edit a Property Grant by Property Id
patch
View a Property Grant by UPRN
get
Delete a Property Grant by UPRN
del
Edit a Property Grant by UPRN
patch
Paginated Property Key Features by Property Id
get
Create a Property Key Feature By Property Id
post
Paginated Property Key Features by UPRN
get
Create a Property Key Feature By UPRN
post
View a Property Key Feature by Property Id
get
Delete a Property Key Feature by Property Id
del
Edit a Property Key Feature by Property Id
patch
View a Property Key Feature by UPRN
get
Delete a Property Grant by UPRN
del
Edit a Property Key Feature by UPRN
patch
Create a Pre-Inspection
post
Paginated Property Tasks
get
Get a Property Task
get
Property Tasks Since Updated
get
Paginated Work Orders by Property Id
get
Paginated Work Orders by UPRN
get
Tasks
Paginated Standalone Tasks
get
Add Event To Task
post
Get Events By Id On Task
get
Get Events By Reference On Task
get
Warehousing
Work Orders Updated Since
get
Work Order Elements Updated Since
get
Post-Inspections Updated Since
get
Work Order Variations Updated Since
get
Work orders' EForms Updated Since
get
Work Order Events Updated Since
get
Work Order Files Updated Since
get
Work Orders Notes Updated Since
get
Users Updated Since
get
Standalone Tasks Updated Since
get
Task Events Updated Since
get
Engagements' Risks Updated Since
get
Referrals' Risks Updated Since
get
Property Attributes Updated Since
get
Property Adaptations Since Updated
get
Property Asbestos Updated Since
get
Property Charges Updated Since
get
Properties Updated Since
get
Properties' Energy Readings Updated Since
get
Property Officers Updated Since
get
Property Ownership Updated Since
get
Property Periods Updated Since
get
Pre-Inspections Updated Since
get
Property Roles Updated Since
get
Properties' EForms Updated Since
get
Properties' Events Updated Since
get
Property Files Updated Since
get
Property Key Set Since Updated
get
Properties' Notes Updated Since
get
Properties' Risks Updated Since
get
Work Order Risks Updated Since
get
Person Attributes Updated Since
get
Person Contacts Updated Since
get
People Updated Since
get
People Events Updated Since
get
Person Files Updated Since
get
People's Risks Updated Since
get
Retrieves a paginated list of attachment files that have been added or modified since a specified point, filtered according to the provided criteria.
get
Occupancy Attributes Updated Since
get
Bypass Addresses Updated Since
get
Occupancies Updated Since
get
Occupancies Arrears Holds Updated Since
get
Occupants Updated Since
get
Occupancies Events Updated Since
get
Occupancy Files Updated Since
get
Occupancies Notes Updated Since
get
Occupancies' Risks Updated Since
get
Occupancies EForms Updated Since
get
Case EForms Updated Since
get
Case Attributes Updated Since
get
Cases Updated Since
get
Case Records Updated Since
get
Case Stages Updated Since
get
Cases Events Updated Since
get
Cases Notes Updated Since
get
Case Risks Updated Since
get
Applications EForms Updated Since
get
Application Attributes Updated Since
get
Applicants Updated Since
get
Applications Updated Since
get
Applications' Previous Address List Updated Since
get
Applications' Waiting Lists Updated Since
get
Applications Events Updated Since
get
Application Files Updated Since
get
Applications Notes Updated Since
get
Application Risks Updated Since
get
Person EForms Updated Since
get
Alternate References Updated Since
get
Arrangements Updated Since
get
Arrears Stages Updated Since
get
Arrears Stage Notes Updated Since
get
Accounts Updated Since
get
Account Transactions Updated Since
get
Void Timelines Updated Since
get
Property Asbestos Surveys Updated Since
get
Property Asbestos Samples Updated Since
get
Work Orders Updated Since
get
Rents to Finance Reports Generated Since
get
Rents to Finance Item Breakdowns
get
Cash to Nominal Reports Generated Since
get
Cash to Nominal Item Breakdowns
get
Cash to Bank Reports Generated Since
get
Cash to Bank Item Breakdowns
get
Adjustments to Finance Reports Generated Since
get
Adjustments to Finance Item Breakdowns
get
Service Charges to Finance Reports Generated Since
get
Service Charges to Finance Item Breakdowns
get
Webhooks
Create Subscription
post
Paginated Webhooks
get
Update Subscription
patch
Activate Subscription
post
Deactivate Subscription
del
Get Webhook By Id
get
Paginated Webhooks Logs
get
Webhooks Logs Updated Since
get
Work Orders
Create Work Order
post
Paginated Work Orders
get
Edit Work Order by Reference
patch
Get Work Order By Reference
get
Edit Work Order by Id
patch
Get Work Order By Id
get
Amend Work Order Completion Date by Reference
patch
Amend Work Order Completion Date by Id
patch
Reprioritise Work Order by Reference
patch
Reprioritise Work Order by Id
patch
Retarget Work Order by Reference
patch
Retarget Work Order by Id
patch
Update Work Order Contact Details by Reference
patch
Update Work Order Contact Details by Id
patch
Update First Time Fix Value by Reference
patch
Update First Time Fix Value Details by Id
patch
Update Work Order Tax Code and Vat by Reference
patch
Update Work Order Tax Code and Vat by Id
patch
Update Work Order Reported Date by Reference
patch
Update Work Order Reported Date by Id
patch
Reassign Work Order Contractor by Reference
patch
Reassign Work Order Contractor by Id
patch
Reassign a Work Order to a New Owner by Reference
patch
Reassign a Work Order to a New Owner by Id
patch
Create a Work Order Hold by Reference
post
Create a Work Order Hold by Id
post
Release Work Order Hold by Reference
post
Release Work Order Hold by Id
post
Bulk Complete Work Orders
post
Submit Work Order Feedback by Reference
post
Submit Work Order Feedback by Id
post
Complete Work Order by Reference
patch
Complete Work Order by Id
patch
Reinstate Work Order by Reference
patch
Reinstate Work Order by Id
patch
Pass the Invoice for Payment by Reference
patch
Pass the Invoice for Payment by Id
patch
Approve Work Order by Reference
post
Approve Work Order by Id
post
Cancel a Work Order bu Reference
post
Cancel a Work Order by Id
post
Get Paginated Work Order Financials
get
Create Work Order Financial Code
post
Get Work Order Financial Details by Id
get
Edit Work Order Financial Code
patch
Split Work Order Financial Code
post
Paginated Work Order Elements
get
Paginated Linked Work Orders
get
Create Linked Work Order
post
Get Linked Work Order
get
Paginated Post-Inspections
get
Get Post-Inspection By Id
get
Create Post-Inspection
post
Re-Assign Post-Inspection
patch
Pass Post-Inspection
patch
Cancel Post-Inspection
patch
Fail Post-Inspection
patch
Re-Submit Post-Inspection
patch
Paginated Work Order Variations
get
Create Work Order Variation
post
Authorise Variations
patch
Get Work Order Variation By Id
get
Get EForms By work order reference
get
Retrieves a paginated list of issued eForms associated with the specified entity.
get
Retrieves a paginated list of issued eForm submissions for the specified customer and eForm.
get
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Retrieves the specified electronic form (eForm) for submission by the current user.
get
Submits a completed eForm for the specified entity and eForm definition.
post
Add Event To Work Order
post
Get Events By Id On Work Order
get
Get Events By Reference On Work Order
get
Upload File To Work Order
post
Paginated Work Order Files
get
Download File From Work Order
get
Delete File From Work Order
del
Add Note To Work Order
post
Get Work Orders By Id On Property
get
Get Paginated Work Order Visits by Reference
get
Create a Work Order Visit
post
Get Paginated Work Order Visits by Id
get
Get a Work Order Visit
get
Update a Work Order Visit
patch
Complete a Work Order Visit
patch
Add Risk To Work Order
post
Get Risks By Id On Work Order
get
Update Risk On Work Order
patch
Reset Risk Score On Work Order
patch
Add risk by Work Order Reference to work order
post
Get risk on Work Order by Work Order Reference
get
Update risk on work order by Work Order Reference and risk name
patch
Get risk on work order by Work Order Reference and risk name
get
Reset risk on work order by Work Order Reference and risk name
post
End risk on work order by Work Order Reference and risk name
post
Check if any Work Orders Require Feedback
get
Repair Requests
Create Repair Request
post
Add Picture to Repair Request
post
Cancel Repair Request
patch
Attributes
Retrieves a paginated list of sub-attribute answers for the specified list attribute question.
get
Retrieves a sub-attribute by its unique identifier.
get
EForms
Download Issued IssuedEForm as a file
get
Uploads a file and associates it with the specified entity.
post
Retrieves a paginated list of files associated with the specified entity.
get
Deletes the specified attachment file associated with the given entity.
del
NewsFeed
Paginated News Feed
get
News Item By Id
get
Download News Item Image
get
Person
Get EForms By person reference
get
Get EForms By Person Id
get
Get All Person eForms for Submission
get
Returns existing submissions for a Person eForm
get
Returns form data and fields for an existing submitted Person eForm
get
Submits a completed eForm for the specified entity and eForm definition.
post
Retrieves the details of a specific issued eForm for editing within the context of a customer and eForm.
get
Updates an existing issued eForm submission for the specified customer and eForm identifiers.
patch
Referrals
Add Risk To Engagement
post
Get Risks By Id On Engagement
get
Update Risk On Engagement
patch
Reset Risk Score On Engagement
patch
Add risk by Engagement Reference to engagement
post
Get risk on engagement by Engagement Reference
get
Update risk on engagement by Engagement Reference and risk name
patch
Get risk on engagement by Engagement Reference and risk name
get
Reset risk on engagement by Engagement Reference and risk name
post
End risk on engagement by Engagement Reference and risk name
post
Add Risk To Referral
post
Get Risks By Id On Referral
get
Update Risk On Referral
patch
Reset Risk Score On Referral
patch
Add risk by Referral Reference to referral
post
Get risk on referral by Referral Reference
get
Update risk on referral by Referral Reference and risk name
patch
Get risk on referral by Referral Reference and risk name
get
Reset risk on referral by Referral Reference and risk name
post
End risk on referral by Referral Reference and risk name
post
Users
Paginated Users
get
Settings
Get Module's questions
get
/v3/settings/third-parties/{id}
get
Get Folders by Module
get
Get Afordability From Integrations
get
Start Afordability Calculator
get
Get Entitled To From Integrations
get
Start Entitled To Calculator
get
Create Transaction for Pay Point
post
Get Transaction Status
get
Get Challenge Result
get
Get Contact Types
get
Get Portal Alert Types
get
Get Portal Menu Options
get
Powered by
Data Types / Handling
Ask AI
