Jump to Content
API Reference
v1.0
v2.3
v3.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v2.3
API Reference
OAuth Resource Password Owner Flow
Search
All
Pages
Start typing to search…
These docs are for v2.3. Click to read the latest docs for v3.0.
JUMP TO
Rubixx Housing API
Accounts
Gets all account information that has been created or updated since the date supplied
get
Adds a direct debit record to the given account
post
Gets information about desired direct debit
get
Gets all account information that has been created or updated since the date supplied
get
Edit the given account alternate reference
patch
Deactivate the given account alternate reference
delete
Activate the given account alternate reference
post
Applications
Adds a file to a folder for an application
post
Arrangements
Retrieves active Arrangements via pagination
get
Retrieves active Arrangements via pagination
get
Arrears
Gets all Arrears notes that have been created since the date supplied
get
Gets all arrears that have been created or updated since the date supplied
get
Attributes
Gets all attributes that have been created or updated since the date supplied within the limit
get
Gets all attributes that have been created or updated since the date supplied within the limit
get
Deletes a given attribute from an entity by its Id
delete
Auth
OAuth Resource Password Owner Flow
post
OAuth Refresh Token
post
Cases
Adds a file to a folder for a case
post
Gets all cases that have been created or updated since the date supplied
get
Gets all case stages that have been created or updated since the date supplied
get
Retrieve all case related items that have been created or updated since the date supplied
get
Retrieve all related items on a selected case that have been created or updated since the date supplied
get
Reprioritise case with given reference, using given priority
patch
Retarget case with given reference, using given date
patch
Edit the case of the given reference (only the edit of the description is available as of allow)
patch
Reassign the owner of a Case
patch
CRMs
Add communication to CRM
post
Gets all communications
get
Gets information about desired Communication
get
Add Service Request to Communication
post
Gets information about desired Service Request
get
Add a task to a service request
post
Gets information about desired Service Request Task
get
Gets all Service Requests information that has been created or updated since the date supplied
get
Gets all information of Service Request Links - Communications that has been created or updated since the date supplied
get
Gets all information of Service Request Links - Work Orders that has been created or updated since the date supplied
get
Gets all information of Service Request Links - Tasks information that has been created or updated since the date supplied
get
Gets all information of Service Request Links - Cases that has been created or updated since the date supplied
get
Gets all information of Service Request Links - Pre-Inspections that has been created or updated since the date supplied
get
Gets all communications have been created or updated since the date supplied
get
Files
Downloads selected file from blob name if it exists
get
Financial
Gets all account transactions that has been created or updated since the date supplied
get
Me
When accessed via API Key authenticated requests it'll return id(s). If accessed via access tokens associated with a customer portal user it will return information on that customer. Contractor and member logins via access tokens are currently not supported.
get
Returns summary information for dashboard use about the current user. Only works with Customer Portal Users currently!
get
Misc
Retrieves all active tenants
get
Gets all events created or updated since the provided date
get
Returns customer portal news feed
get
Requests a password reset email for target with return true or false in body for if it was successful
post
Gets all users
get
Notes
GET endpoint for retrieving a paginated list of notes for a specific entity accessed by using the Id
get
Occupancies
Gets occupancies via pagination
get
Adds a file to a folder for an occupancy
post
Gets all occupancies that have been created or updated since the date supplied
get
Gets all occupancy occupants that have been created or updated since the date supplied
get
Gets the bypass addresses of an occupancy
get
Gets the bypass changes since the given date
get
People
Adds a file to a folder for a person
post
Gets all people information that has been created or updated since the date supplied
get
Gets all person contacts that have been created or updated since the date supplied
get
/v2/people/{personReference}/avatar
post
Updates a persons details
patch
Get a paginated list of a person's contact details
get
Adds a new person contact detail
post
Searches if this person has the provided contact detail and returns our information on it
get
Deletes a given contact type
delete
Returns a paginated list in priority order for the given contact type
get
Replaces an existing person contact detail's information
put
Properties
Gets all property information that has been created or updated since the date supplied
get
Gets all information of property charges that has been created or updated since the date supplied
get
Gets all information of alternative property charges that has been created or updated since the date supplied
get
Gets all the requested properties via the IDs that are passed in
get
Updates the service date of a component against the specified property
post
Add a certificate to the Workorder property Component
post
Adds a file to a folder for an property
post
Get Asbestos by Property UPRN
get
Add Asbestos to property
post
Gets all asbestos information that has been created or updated since the date supplied
get
Update Asbestos record
post
Changes the department of the specified void
post
Gets all voids information that has been created or updated since the date supplied
get
Gets all property components that have been created or updated since the date supplied
get
Update a component on the property
patch
Gets all information of property roles that have been created or updated since the date supplied
get
Gets all information of void department timeline that have been created or updated since the date supplied
get
Update a component condition on the property
patch
Repair Requests
/v2.2/repairrequests
post
/v2.2/repairrequests
get
/v2.2/repairrequests/{repairRequestId}
get
/v2.2/repairrequests/{repairRequestId}
delete
/v2.2/repairrequests/{repairRequestId}/accept
post
/v2.2/repairrequests/{repairRequestId}/decline
post
Risks
Get all risks changed or updated in the date provided
get
Support Schemes
Gets support schemes via pagination
get
Creates a new support scheme based on payload
post
Gets a support scheme based on url
get
Updates an existing support scheme with given reference based on payload
patch
Updates an existing support scheme capacity with given reference based on payload
patch
Gets linked properties of support scheme via pagination
get
Adds linked property to support scheme with given reference based on payload
post
Gets linked property of a support scheme based on url
get
Removes linked property with given UPRN from support scheme
delete
Gets scheme members via pagination
get
Adds members to support scheme with given name list based on payload
post
Removes member with given name from support scheme with based on url
delete
Gets Scheme referrals via pagination
get
Creates new referral for support scheme with given information based on payload
post
Gets scheme referral based on url
get
Edit an existing referral for support scheme with given information based on payload
patch
Rejects referral with given reference from Support Scheme with given reference
delete
Gets referral tasks via pagination
get
Creates new task for support scheme referral with given information based on payload
post
Gets referral task based on url
get
Gets Scheme engagements via pagination
get
Creates new Scheme engagement with given information based on payload
post
Gets Scheme engagement based on url
get
Edit scheme engagement with engagement reference and given information based on payload
patch
End scheme engagement with engagement reference and given information based on payload
delete
Creates new Scheme engagement with Referral reference and given information based on payload
post
Gets Scheme engagement tasks via pagination
get
Creates new task for scheme engagement with given information based on payload
post
Gets Scheme engagement task based on Url
get
Gets scheme engagement goals via pagination
get
Creates new goal for scheme engagement with given information based on payload
post
Gets scheme engagement goal based on url
get
Edit goal for scheme engagement with given information based on payload
patch
Remove scheme engagement goal with given id
delete
Gets engagement goal actions via pagination
get
Creates new action for engagement goal with given information based on payload
post
Gets engagement goal action based on url
get
Completes goal action with given information based on url
patch
Removes goal action with given information based on url
delete
Gets scheme tasks via pagination
get
Creates new task for support scheme with given information based on payload
post
Gets scheme task based on url
get
Gets scheme notes via pagination
get
Creates new scheme note with given information based on payload
post
Gets scheme note based on url
get
Removes scheme note with given information based on url
delete
Gets scheme handover notes via pagination
get
Creates new scheme handover note with given information based on payload
post
Gets scheme handover note
get
Closes scheme handover note with given information based on url
delete
Tasks
Gets all tasks created or updated since the provided date
get
Adds a file to a folder for a Task
post
Visits
Close a visit
post
Create a Visit
post
Get Changes Since
get
Update a visit
patch
Work Orders
Adds a file to a folder for a WorkOrder
post
Creates a visit for a WorkOrder
post
Edit a visit for a WorkOrder
patch
Creates a new external invoice record
post
Gets all work orders created or updated since the provided date
get
Reinstate the work order if it's currently "Work Completed"
post
Reassign the Managing Officer on a Work Order
post
Link Work Orders
post
Remove Linked Work Order From a Work Order
delete
Get information of Linked Work Orders that have been created or updated since the date supplied
get
Get All Linked Work Orders from a Work Order
get
Edit the details of a WorkOrder
patch
Gets all work order financial codes created or updated since the provided date
get
Marks a Work Order as "Paid" if it's currently "Passed for Payment"
post
Edit the details of a WorkOrder
patch
Powered by
OAuth Resource Password Owner Flow
post
https://{tenant}.rubixx.app/api/v2.1/auth/token
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
tenant
.rubixx.app/api
/v2.1/auth/token
RESPONSE
Click
Try It!
to start a request and see the response here!
