Retrieve your organisation
GET /v1/organisation
The organisation the key acts on (its sandbox for test keys), with livemode.
curl https://api.housing-iq.com/v1/organisation \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Every endpoint of the HOUSING-iQ API, version 2026-11-22. Generated from the API's own OpenAPI document.
Base URL https://api.housing-iq.com/v1. Send your key as Authorization: Bearer hiq_live_... or hiq_test_.... Bodies are JSON. Field names are the same in requests, responses, events and webhooks.
GET /v1/organisation
The organisation the key acts on (its sandbox for test keys), with livemode.
curl https://api.housing-iq.com/v1/organisation \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
The homes your organisation manages.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
scheme | string, nullable | create, update | The scheme or estate the home belongs to. |
address_line1 | string | create (required), update | First line of the address. |
address_line2 | string, nullable | create, update | Second line of the address. |
city | string, nullable | create, update | Town or city. |
postcode | string | create (required), update | UK postcode. |
property_type | string, nullable flat, house, bedsit, bungalow, maisonette, room, other | create, update | Kind of home. |
bedrooms | integer, nullable | create, update | Number of bedrooms. |
status | string, nullable occupied, void, unavailable | create, update | Whether the home is lived in. |
latitude | number, nullable | create, update | Latitude. |
longitude | number, nullable | create, update | Longitude. |
formatted_address | string, nullable | read only | The full address on one line, when known. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
deleted_at | date-time, nullable | read only | When the record was removed. Removed records are only listed with include_deleted=true. |
{
"object": "property",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"scheme": "Alder Estate",
"address_line1": "14 Alder Court",
"address_line2": "text",
"city": "Sandbourne",
"postcode": "SB1 1AA",
"property_type": "flat",
"bedrooms": 2,
"status": "occupied",
"latitude": 1,
"longitude": 1,
"formatted_address": "text",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z",
"deleted_at": null
}GET /v1/properties
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
include_deleted | boolean | Include removed records. |
scheme | string | Filter by scheme. Separate several values with commas. |
postcode | string | Filter by postcode. Separate several values with commas. |
property_type | string flat, house, bedsit, bungalow, maisonette, room, other | Filter by property_type. Separate several values with commas. |
status | string occupied, void, unavailable | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/properties?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/properties
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/properties \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"address_line1": "14 Alder Court",
"postcode": "SB1 1AA"
}'
GET /v1/properties/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/properties/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/properties/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/properties/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"scheme": "Alder Estate",
"address_line1": "14 Alder Court"
}'
DELETE /v1/properties/{id}
Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X DELETE https://api.housing-iq.com/v1/properties/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
The people who live in your homes. Creating a tenant creates their HOUSING-iQ account and returns a one-time temporary password for you to hand over; they choose their own password when they first sign in.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
first_name | string | create (required) | First name. |
last_name | string | create (required) | Last name. |
email | string | create (required) | Email address, used to sign in and for email updates. |
language | string, nullable | read only | Language the tenant uses the app in (en, pl, ro, so, ur, ar). |
is_active | boolean | read only | False when the account has been deactivated. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "tenant",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"first_name": "Amara",
"last_name": "Okafor",
"email": "amara.okafor@example.org",
"language": "en",
"is_active": true,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/tenants
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
email | string | Filter by email. Separate several values with commas. |
is_active | boolean | Filter by is_active. Separate several values with commas. |
curl https://api.housing-iq.com/v1/tenants?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/tenants
Creates the tenant and their account. The response includes temporary_password once; hand it to the tenant privately. Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/tenants \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"first_name": "Amara",
"last_name": "Okafor",
"email": "amara.okafor@example.org"
}'
GET /v1/tenants/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/tenants/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Who lives where, on what kind of tenancy.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
property_id | id | create (required) | The home (see Properties). |
tenant_id | id | create (required) | The tenant (see Tenants). |
household_id | id, nullable | create, update | The household, when grouped. |
start_date | date, nullable | create, update | Tenancy start date. |
end_date | date, nullable | create, update | Tenancy end date, if ended. |
tenancy_type | string, nullable secure, assured, starter, temporary, emergency, licence | create, update | Kind of tenancy. |
is_lead | boolean, nullable | create, update | The lead tenant of the household. |
weekly_charge | number, nullable | create, update | Weekly rent, in pounds. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
deleted_at | date-time, nullable | read only | When the record was removed. Removed records are only listed with include_deleted=true. |
{
"object": "tenancy",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"household_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"start_date": "2026-11-24",
"end_date": "2026-11-24",
"tenancy_type": "secure",
"is_lead": true,
"weekly_charge": 112.4,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z",
"deleted_at": null
}GET /v1/tenancies
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
include_deleted | boolean | Include removed records. |
property_id | string | Filter by property_id. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
tenancy_type | string secure, assured, starter, temporary, emergency, licence | Filter by tenancy_type. Separate several values with commas. |
curl https://api.housing-iq.com/v1/tenancies?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/tenancies
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/tenancies \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21"
}'
GET /v1/tenancies/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/tenancies/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/tenancies/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/tenancies/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"household_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"start_date": "2026-11-24"
}'
DELETE /v1/tenancies/{id}
Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X DELETE https://api.housing-iq.com/v1/tenancies/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Repairs reported by tenants or staff. HOUSING-iQ works out the Awaab's Law deadlines and repair target when a repair is created or its priority changes; record what was done with the awaab_*_at fields.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
reference | string, nullable | read only | Reference shown to the tenant, such as REP-0042. |
tenant_id | id | create (required) | The tenant (see Tenants). |
property_id | id, nullable | create, update | The home (see Properties). |
category | string damp_mould, heating, plumbing, electrical, doors_windows, pests, safety_hazard, general | create (required), update | What needs repairing. |
title | string | create (required), update | Short description. |
description | string, nullable | create, update | Full description. |
priority | string, nullable emergency, urgent, routine | create, update | Priority. Sets the repair target. |
status | string, nullable new, triaged, assigned, scheduled, in_progress, completed, cancelled | update | Where the repair has got to. The tenant is told of each change. |
is_damp | boolean, nullable | create, update | Damp or mould is involved. |
is_repeat | boolean, nullable | read only | The same problem has been reported before. |
hazard_type | string, nullable damp_mould, excess_cold, excess_heat, falls, structural_collapse, fire_explosion, electrical, domestic_hygiene, other_hhsrs | create, update | The Awaab's Law hazard, if any. |
hazard_class | string, nullable none, significant, emergency | create, update | Awaab's Law class: an emergency hazard gets a 24-hour clock. |
reported_at | date-time, nullable | read only | When the repair was reported. |
target_date | date, nullable | read only | Repair target date (from your repair targets). |
sla_due_at | date-time, nullable | read only | Repair target, as a time. |
scheduled_for | date-time, nullable | update | Booked visit. The tenant is told. |
completed_at | date-time, nullable | read only | When the repair was completed. |
assigned_to | id, nullable | update | The officer responsible (a staff member id). |
contractor_name | string, nullable | update | Contractor contact name. |
contractor_company | string, nullable | update | Contractor company. |
contractor_phone | string, nullable | update | Contractor phone number, shown to the tenant. |
awaab_aware_at | date-time, nullable | read only | When the landlord became aware (Awaab's Law clock start). |
awaab_emergency_by | date-time, nullable | read only | Emergency hazards: make safe by (24 hours). |
awaab_investigate_by | date, nullable | read only | Investigate by (10 working days). |
awaab_summary_by | date, nullable | read only | Written summary to the tenant by (3 working days after investigating). |
awaab_fix_by | date, nullable | read only | Begin safety work by (5 working days after investigating). |
awaab_preventative_start_by | date, nullable | read only | Start further work by. |
awaab_preventative_latest | date, nullable | read only | Further work physically under way by (12 weeks). |
awaab_investigated_at | date-time, nullable | update | When the investigation was done. The later deadlines follow from it. |
awaab_summary_sent_at | date-time, nullable | update | When the written summary was sent. |
awaab_safety_work_done_at | date-time, nullable | update | When the home was made safe. |
awaab_preventative_started_at | date-time, nullable | update | When further work started. |
ai_urgency_score | integer, nullable | read only | Urgency score (0 to 100) from the automatic triage, for staff to confirm. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "repair",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"reference": "REP-0042",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"category": "damp_mould",
"title": "Black mould in the bedroom",
"description": "Mould on the wall behind the wardrobe.",
"priority": "emergency",
"status": "new",
"is_damp": true,
"is_repeat": true,
"hazard_type": "damp_mould",
"hazard_class": "none",
"reported_at": null,
"target_date": "2026-11-24",
"sla_due_at": null,
"scheduled_for": "2026-11-24T10:30:00Z",
"completed_at": null,
"assigned_to": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"contractor_name": "Sam Patel",
"contractor_company": "Alder Builders",
"contractor_phone": "020 7946 0000",
"awaab_aware_at": null,
"awaab_emergency_by": "2026-11-24T10:30:00Z",
"awaab_investigate_by": "2026-11-24",
"awaab_summary_by": "2026-11-24",
"awaab_fix_by": "2026-11-24",
"awaab_preventative_start_by": "2026-11-24",
"awaab_preventative_latest": "2026-11-24",
"awaab_investigated_at": null,
"awaab_summary_sent_at": null,
"awaab_safety_work_done_at": null,
"awaab_preventative_started_at": null,
"ai_urgency_score": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/repairs
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
reference | string | Filter by reference. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
property_id | string | Filter by property_id. Separate several values with commas. |
category | string damp_mould, heating, plumbing, electrical, doors_windows, pests, safety_hazard, general | Filter by category. Separate several values with commas. |
priority | string emergency, urgent, routine | Filter by priority. Separate several values with commas. |
status | string new, triaged, assigned, scheduled, in_progress, completed, cancelled | Filter by status. Separate several values with commas. |
is_damp | boolean | Filter by is_damp. Separate several values with commas. |
curl https://api.housing-iq.com/v1/repairs?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/repairs
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/repairs \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"category": "damp_mould",
"title": "Black mould in the bedroom",
"priority": "urgent",
"is_damp": true
}'
GET /v1/repairs/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/repairs/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/repairs/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/repairs/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "scheduled",
"scheduled_for": "2026-11-27T10:00:00Z",
"contractor_company": "Alder Builders"
}'
GET /v1/repairs/{id}/events
| Parameter | Type | Description |
|---|---|---|
id path | id | |
limit | integer | |
starting_after | string |
curl https://api.housing-iq.com/v1/repairs/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12/events?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Each repair's history: created, triaged, assigned, scheduled, status changes and completion.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
repair_id | id | read only | The repair. |
event_type | string created, ai_triage, status_change, note, scheduled, assigned, escalation, completed, priority_change, contractor | read only | What happened. |
actor_type | string tenant, staff, ai, system | read only | Who did it. |
actor_id | id, nullable | read only | The person, when a person did it. |
body | string, nullable | read only | Details. |
created_at | date-time | read only | When the record was created. |
{
"object": "repair_event",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"repair_id": "4b3a2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"event_type": "created",
"actor_type": "tenant",
"actor_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"body": "Bin collections move to Tuesdays from 1 December.",
"created_at": "2026-11-24T10:30:00Z"
}GET /v1/repair_events
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
repair_id | string | Filter by repair_id. Separate several values with commas. |
event_type | string created, ai_triage, status_change, note, scheduled, assigned, escalation, completed, priority_change, contractor | Filter by event_type. Separate several values with commas. |
curl https://api.housing-iq.com/v1/repair_events?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/repair_events/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/repair_events/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Complaints, followed through both stages of the Housing Ombudsman's Complaint Handling Code. HOUSING-iQ sets the acknowledgement and reply deadlines in working days.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
reference | string, nullable | read only | Reference, such as CMP-0012. |
tenant_id | id | create (required) | The tenant (see Tenants). |
subject | string | create (required) | What the complaint is about, in a line. |
description | string | create (required) | The complaint in full. |
category | string, nullable repairs, anti_social_behaviour, staff, rent_and_charges, communication, neighbourhood, other | create | Category. |
desired_outcome | string, nullable | create | What the tenant would like to happen. |
channel | string, nullable app, phone, in_person, letter, email, other | create | How the complaint was made. |
received_at | date-time, nullable | create | When it was received (defaults to now). |
stage | string, nullable stage_1, stage_2, ombudsman | read only | Stage. |
status | string, nullable open, acknowledged, responded, closed | read only | Status. |
owner_id | id, nullable | update | The member of staff handling it. |
stage1_acknowledge_by | date, nullable | read only | Stage 1: acknowledge by. |
stage1_acknowledged_at | date-time, nullable | update | Stage 1: when acknowledged. |
stage1_respond_by | date, nullable | read only | Stage 1: reply by. |
stage1_extended_to | date, nullable | update | Stage 1: extended reply date. |
stage1_extension_reason | string, nullable | update | Stage 1: why the reply date was extended. |
stage1_responded_at | date-time, nullable | update | Stage 1: when the reply was sent. |
stage1_response | string, nullable | update | Stage 1: the reply. |
escalated_at | date-time, nullable | read only | When it went to stage 2. |
escalation_reason | string, nullable | read only | Why it went to stage 2. |
stage2_acknowledge_by | date, nullable | read only | Stage 2: acknowledge by. |
stage2_acknowledged_at | date-time, nullable | update | Stage 2: when acknowledged. |
stage2_respond_by | date, nullable | read only | Stage 2: reply by. |
stage2_extended_to | date, nullable | update | Stage 2: extended reply date. |
stage2_extension_reason | string, nullable | update | Stage 2: why the reply date was extended. |
stage2_responded_at | date-time, nullable | update | Stage 2: when the reply was sent. |
stage2_response | string, nullable | update | Stage 2: the reply. |
closed_at | date-time, nullable | read only | When it was closed. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "complaint",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"reference": "REP-0042",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"subject": "Repair not booked",
"description": "Mould on the wall behind the wardrobe.",
"category": "repairs",
"desired_outcome": "text",
"channel": "app",
"received_at": null,
"stage": "stage_1",
"status": "open",
"owner_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"stage1_acknowledge_by": "2026-11-24",
"stage1_acknowledged_at": null,
"stage1_respond_by": "2026-11-24",
"stage1_extended_to": null,
"stage1_extension_reason": null,
"stage1_responded_at": null,
"stage1_response": null,
"escalated_at": null,
"escalation_reason": null,
"stage2_acknowledge_by": "2026-11-24",
"stage2_acknowledged_at": null,
"stage2_respond_by": "2026-11-24",
"stage2_extended_to": null,
"stage2_extension_reason": null,
"stage2_responded_at": null,
"stage2_response": null,
"closed_at": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/complaints
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
reference | string | Filter by reference. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
category | string repairs, anti_social_behaviour, staff, rent_and_charges, communication, neighbourhood, other | Filter by category. Separate several values with commas. |
channel | string app, phone, in_person, letter, email, other | Filter by channel. Separate several values with commas. |
stage | string stage_1, stage_2, ombudsman | Filter by stage. Separate several values with commas. |
status | string open, acknowledged, responded, closed | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/complaints?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/complaints
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/complaints \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"subject": "Repair not booked",
"description": "Mould on the wall behind the wardrobe."
}'
GET /v1/complaints/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/complaints/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/complaints/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/complaints/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"owner_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"stage1_acknowledged_at": "2026-11-24T10:30:00Z"
}'
Casework: support, arrears, welfare, safeguarding and tenancy cases. Needs the sensitive scope.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
reference | string, nullable | read only | Reference, such as CASE-0007. |
tenant_id | id | read only | The tenant (see Tenants). |
case_type | string rent_arrears, asb, welfare, repairs_related, safeguarding, complaint, tenancy, other | read only | Kind of case. |
title | string | read only | Title. |
summary | string, nullable | read only | Summary written by staff. |
priority | string, nullable p1, p2, p3, p4 | read only | Priority (p1 highest). |
status | string, nullable open, in_progress, on_hold, closed | read only | Status. |
risk_level | string, nullable low, medium, high | read only | Risk level. |
owner_id | id, nullable | read only | Case owner. |
opened_at | date-time, nullable | read only | Opened. |
closed_at | date-time, nullable | read only | Closed. |
outcome | string, nullable resolved, signposted, no_action, escalated, withdrawn | read only | Outcome. |
closure_summary | string, nullable | read only | Summary written when closing. |
linked_repair_id | id, nullable | read only | A linked repair. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "case",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"reference": "REP-0042",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"case_type": "rent_arrears",
"title": "Black mould in the bedroom",
"summary": "text",
"priority": "p1",
"status": "open",
"risk_level": "low",
"owner_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"opened_at": null,
"closed_at": null,
"outcome": "resolved",
"closure_summary": "text",
"linked_repair_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/cases
Newest first. Needs the read and sensitive scopes.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
reference | string | Filter by reference. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
case_type | string rent_arrears, asb, welfare, repairs_related, safeguarding, complaint, tenancy, other | Filter by case_type. Separate several values with commas. |
priority | string p1, p2, p3, p4 | Filter by priority. Separate several values with commas. |
status | string open, in_progress, on_hold, closed | Filter by status. Separate several values with commas. |
risk_level | string low, medium, high | Filter by risk_level. Separate several values with commas. |
curl https://api.housing-iq.com/v1/cases?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/cases/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/cases/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Support visits, inspections, reviews and other appointments. The tenant is told when one is booked, moved or cancelled. Repair visits are booked on the repair itself (set scheduled_for on the repair) and HOUSING-iQ adds the appointment for you, so they are listed here but not created here.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
tenant_id | id | create (required) | The tenant (see Tenants). |
title | string | create (required), update | What the appointment is. |
appointment_type | string, nullable repair_visit, support_visit, inspection, review, other | create, update | Kind of appointment. repair_visit appointments come from repairs and cannot be created here. |
scheduled_for | date-time | create (required), update | When it is. |
duration_mins | integer, nullable | create, update | Length in minutes. |
status | string, nullable requested, confirmed, completed, cancelled, missed | create, update | Status. |
location | string, nullable | create, update | Where. |
contractor_name | string, nullable | create, update | Who is coming. |
notes | string, nullable | create, update | Notes for the tenant. |
repair_id | id, nullable | read only | For repair visits: the repair. |
cancel_reason | string, nullable | update | Why it was cancelled. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
deleted_at | date-time, nullable | read only | When the record was removed. Removed records are only listed with include_deleted=true. |
{
"object": "appointment",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"title": "Black mould in the bedroom",
"appointment_type": "repair_visit",
"scheduled_for": "2026-11-24T10:30:00Z",
"duration_mins": 60,
"status": "requested",
"location": "text",
"contractor_name": "Sam Patel",
"notes": "text",
"repair_id": "4b3a2c1d-0e9f-4a8b-9c7d-6e5f4a3b2c1d",
"cancel_reason": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z",
"deleted_at": null
}GET /v1/appointments
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
include_deleted | boolean | Include removed records. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
appointment_type | string repair_visit, support_visit, inspection, review, other | Filter by appointment_type. Separate several values with commas. |
status | string requested, confirmed, completed, cancelled, missed | Filter by status. Separate several values with commas. |
repair_id | string | Filter by repair_id. Separate several values with commas. |
curl https://api.housing-iq.com/v1/appointments?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/appointments
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/appointments \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"title": "Black mould in the bedroom",
"scheduled_for": "2026-11-24T10:30:00Z"
}'
GET /v1/appointments/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/appointments/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/appointments/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/appointments/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Black mould in the bedroom",
"appointment_type": "repair_visit"
}'
One rent account per tenant. The balance changes only through rent transactions; weekly rent is added by HOUSING-iQ on the day it is due.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
tenant_id | id | create (required) | The tenant (see Tenants). |
tenancy_id | id, nullable | create | The tenancy. |
balance | number, nullable | read only | Amount owed, in pounds (negative means in credit). |
weekly_charge | number, nullable | create (required), update | Weekly rent, in pounds. |
next_due_date | date, nullable | create, update | When rent is next added. Cannot be in the past. |
payment_plan_note | string, nullable | update | Note on any payment plan. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "rent_account",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"tenancy_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"balance": 224.8,
"weekly_charge": 112.4,
"next_due_date": "2026-11-24",
"payment_plan_note": "text",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/rent_accounts
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
curl https://api.housing-iq.com/v1/rent_accounts?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/rent_accounts
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/rent_accounts \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"weekly_charge": 112.4
}'
GET /v1/rent_accounts/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/rent_accounts/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/rent_accounts/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/rent_accounts/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"weekly_charge": 112.4,
"next_due_date": "2026-11-24"
}'
The rent statement. A line is never edited or deleted: put a mistake right with an adjustment. Charges are positive; payments and Housing Benefit or Universal Credit are negative; an adjustment can be either and needs a description.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
rent_account_id | id | create (required) | The rent account. |
tenant_id | id | read only | The tenant (taken from the rent account). |
amount | number | create (required) | Amount in pounds: positive adds to what is owed, negative reduces it. |
txn_type | string charge, payment, adjustment, housing_benefit | create (required) | Kind of line. |
status | string, nullable confirmed, pending, disputed | read only | Lines you record are confirmed; payments tenants log wait for staff to check. |
description | string, nullable | create | What the line is for (required for adjustments). |
occurred_on | date, nullable | create | Date of the payment or charge (up to a year back, not in the future). |
charge_for | date, nullable | read only | For weekly rent added by HOUSING-iQ: the week it is for. |
recorded_by | id, nullable | read only | Who recorded it. |
created_at | date-time | read only | When the record was created. |
{
"object": "rent_transaction",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"rent_account_id": "7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"amount": -120.5,
"txn_type": "charge",
"status": "confirmed",
"description": "Mould on the wall behind the wardrobe.",
"occurred_on": "2026-11-24",
"charge_for": "2026-11-24",
"recorded_by": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"created_at": "2026-11-24T10:30:00Z"
}GET /v1/rent_transactions
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
rent_account_id | string | Filter by rent_account_id. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
txn_type | string charge, payment, adjustment, housing_benefit | Filter by txn_type. Separate several values with commas. |
status | string confirmed, pending, disputed | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/rent_transactions?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/rent_transactions
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/rent_transactions \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"rent_account_id": "7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b",
"amount": -120.5,
"txn_type": "charge"
}'
GET /v1/rent_transactions/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/rent_transactions/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
ASB reports. The diary that goes with each report cannot be changed and is not available through the API. Needs the sensitive scope.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
reference | string, nullable | read only | Reference. |
tenant_id | id | read only | The tenant (see Tenants). |
category | string | read only | Kind of behaviour. |
description | string | read only | What happened. |
location | string, nullable | read only | Where. |
involves | string, nullable residents, external, both, unknown | read only | Who was involved. |
status | string, nullable open, investigating, resolved, closed | read only | Status. |
risk_level | string, nullable standard, medium, high | read only | Risk level. |
hate_incident | boolean, nullable | read only | Recorded as a hate incident (TSM NM01). |
owner_id | id, nullable | read only | Officer. |
closure_summary | string, nullable | read only | What was done. |
closed_at | date-time, nullable | read only | Closed. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "asb_report",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"reference": "REP-0042",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"category": "text",
"description": "Mould on the wall behind the wardrobe.",
"location": "text",
"involves": "residents",
"status": "open",
"risk_level": "standard",
"hate_incident": false,
"owner_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"closure_summary": "text",
"closed_at": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/asb_reports
Newest first. Needs the read and sensitive scopes.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
reference | string | Filter by reference. Separate several values with commas. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
category | string | Filter by category. Separate several values with commas. |
status | string open, investigating, resolved, closed | Filter by status. Separate several values with commas. |
risk_level | string standard, medium, high | Filter by risk_level. Separate several values with commas. |
curl https://api.housing-iq.com/v1/asb_reports?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/asb_reports/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/asb_reports/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Home inspections.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
property_id | id | create (required) | The home (see Properties). |
inspector_id | id, nullable | create, update | The inspecting member of staff. |
scheduled_for | date-time, nullable | create, update | When. |
status | string, nullable scheduled, in_progress, completed | update | Status. |
notes | string, nullable | create, update | Notes. |
completed_at | date-time, nullable | read only | When it was completed. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "inspection",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"inspector_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"scheduled_for": "2026-11-24T10:30:00Z",
"status": "scheduled",
"notes": "text",
"completed_at": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/inspections
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
property_id | string | Filter by property_id. Separate several values with commas. |
status | string scheduled, in_progress, completed | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/inspections?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/inspections
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/inspections \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}'
GET /v1/inspections/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/inspections/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/inspections/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/inspections/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"inspector_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"scheduled_for": "2026-11-24T10:30:00Z"
}'
Empty homes, from vacant to let.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
property_id | id | create (required) | The home (see Properties). |
vacated_on | date, nullable | create, update | When the home became empty. |
status | string, nullable vacant, works, ready, let | create, update | Status. |
days_vacant | integer, nullable | read only | Days empty (worked out for you). |
allocation_notes | string, nullable | create, update | Allocation notes. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "void",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"vacated_on": "2026-11-24",
"status": "vacant",
"days_vacant": 3,
"allocation_notes": "text",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/voids
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
property_id | string | Filter by property_id. Separate several values with commas. |
status | string vacant, works, ready, let | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/voids?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/voids
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/voids \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}'
GET /v1/voids/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/voids/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/voids/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/voids/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"vacated_on": "2026-11-24",
"status": "vacant"
}'
Gas, electrical, energy, fire risk and legionella certificates for each home.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
property_id | id | create (required) | The home (see Properties). |
cert_type | string gas_cp12, eicr, epc, fire_risk, legionella | create (required) | Kind of certificate. |
issued_on | date, nullable | create, update | Issued. |
expires_on | date, nullable | create, update | Expires. |
status | string, nullable valid, due_soon, expired | create, update | Status. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "compliance_certificate",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"cert_type": "gas_cp12",
"issued_on": "2026-11-24",
"expires_on": "2026-11-24",
"status": "valid",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/compliance_certificates
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
property_id | string | Filter by property_id. Separate several values with commas. |
cert_type | string gas_cp12, eicr, epc, fire_risk, legionella | Filter by cert_type. Separate several values with commas. |
status | string valid, due_soon, expired | Filter by status. Separate several values with commas. |
curl https://api.housing-iq.com/v1/compliance_certificates?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/compliance_certificates
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/compliance_certificates \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"property_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"cert_type": "gas_cp12"
}'
GET /v1/compliance_certificates/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/compliance_certificates/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/compliance_certificates/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/compliance_certificates/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"issued_on": "2026-11-24",
"expires_on": "2026-11-24"
}'
Documents shared with tenants, and whether each has been signed. File contents are not available through the API.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
tenant_id | id | read only | The tenant (see Tenants). |
title | string | read only | Title. |
category | string, nullable tenancy, certificate, guide, form, other | read only | Category. |
requires_signature | boolean, nullable | read only | The tenant is asked to sign it. |
sign_state | string, nullable none, requested, signed | read only | Signature status. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
{
"object": "document",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"title": "Black mould in the bedroom",
"category": "tenancy",
"requires_signature": false,
"sign_state": "none",
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z"
}GET /v1/documents
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
category | string tenancy, certificate, guide, form, other | Filter by category. Separate several values with commas. |
sign_state | string none, requested, signed | Filter by sign_state. Separate several values with commas. |
curl https://api.housing-iq.com/v1/documents?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/documents/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/documents/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
News and alerts shown to tenants in the app.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
title | string | create (required), update | Title. |
body | string | create (required), update | Text. |
tone | string, nullable info, warning, good_news | create, update | How it is shown. |
audience | string, nullable org, households, tenants | create, update | Who sees it. |
audience_ids | list of strings, nullable | create, update | Household or tenant ids, when the audience is households or tenants. |
published_at | date-time, nullable | create, update | When it is shown from. |
created_at | date-time | read only | When the record was created. |
updated_at | date-time | read only | When the record last changed. |
deleted_at | date-time, nullable | read only | When the record was removed. Removed records are only listed with include_deleted=true. |
{
"object": "notice",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"title": "Black mould in the bedroom",
"body": "Bin collections move to Tuesdays from 1 December.",
"tone": "info",
"audience": "org",
"audience_ids": [],
"published_at": null,
"created_at": "2026-11-24T10:30:00Z",
"updated_at": "2026-11-24T10:30:00Z",
"deleted_at": null
}GET /v1/notices
Newest first. Needs the read scope.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
updated_since | date-time | Only records changed at or after this time. Use it to sync. |
include_deleted | boolean | Include removed records. |
curl https://api.housing-iq.com/v1/notices?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
POST /v1/notices
Needs the write scope. Send an Idempotency-Key header to make retries safe.
| Parameter | Type | Description |
|---|---|---|
Idempotency-Key header | string | Any unique value; a retry with the same key returns the first response. |
curl -X POST https://api.housing-iq.com/v1/notices \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"title": "Black mould in the bedroom",
"body": "Bin collections move to Tuesdays from 1 December."
}'
GET /v1/notices/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/notices/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
PATCH /v1/notices/{id}
Send only the fields to change. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X PATCH https://api.housing-iq.com/v1/notices/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Black mould in the bedroom",
"body": "Bin collections move to Tuesdays from 1 December."
}'
DELETE /v1/notices/{id}
Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl -X DELETE https://api.housing-iq.com/v1/notices/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
Wellbeing check-ins from tenants and how staff responded. Needs the sensitive scope. Needs the sensitive scope.
| Field | Type | Write | Description |
|---|---|---|---|
object | string | read only | The kind of object. |
id | id | read only | Unique identifier. |
tenant_id | id | read only | The tenant (see Tenants). |
mood | string great, good, okay, low, struggling | read only | Mood. |
stress | integer, nullable | read only | Stress, 1 to 5. |
loneliness | integer, nullable | read only | Loneliness, 1 to 5. |
sleep | integer, nullable | read only | Sleep, 1 to 5. |
crisis_flagged | boolean, nullable | read only | May signal a crisis. |
responded_at | date-time, nullable | read only | When staff responded. |
response_action | string, nullable spoke_to_tenant, visited, referred, emergency_services, left_message, no_answer | read only | What staff did. |
created_at | date-time | read only | When the record was created. |
{
"object": "checkin",
"id": "6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12",
"tenant_id": "2d9e7a10-5b4c-4f8e-a1d3-7c6b5e4f3a21",
"mood": "great",
"stress": 3,
"loneliness": 3,
"sleep": 3,
"crisis_flagged": false,
"responded_at": null,
"response_action": null,
"created_at": "2026-11-24T10:30:00Z"
}GET /v1/checkins
Newest first. Needs the read and sensitive scopes.
| Parameter | Type | Description |
|---|---|---|
limit | integer | How many to return (1 to 100). |
starting_after | string | The next_cursor from the previous page. |
created_after | date-time | Only records created after this time. |
created_before | date-time | Only records created before this time. |
tenant_id | string | Filter by tenant_id. Separate several values with commas. |
mood | string great, good, okay, low, struggling | Filter by mood. Separate several values with commas. |
crisis_flagged | boolean | Filter by crisis_flagged. Separate several values with commas. |
curl https://api.housing-iq.com/v1/checkins?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/checkins/{id}
| Parameter | Type | Description |
|---|---|---|
id path | id |
curl https://api.housing-iq.com/v1/checkins/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/events
Every change, oldest first, kept for 30 days. Pass the next_after value back as after to read on from where you stopped.
| Parameter | Type | Description |
|---|---|---|
after | string | Only events after this event id. |
since | date-time | Only events at or after this time. |
type | string | Event types, separated by commas. |
limit | integer |
curl https://api.housing-iq.com/v1/events?limit=2 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/events/{id}
| Parameter | Type | Description |
|---|---|---|
id path | string |
curl https://api.housing-iq.com/v1/events/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
-H "Authorization: Bearer $HOUSING_IQ_KEY"
GET /v1/export/{resource}
One JSON object per line, oldest first, up to 100,000 records. Takes the same filters as the list. Use it to load your data warehouse.
| Parameter | Type | Description |
|---|---|---|
resource path | string properties, tenants, tenancies, repairs, repair_events, complaints, cases, appointments, rent_accounts, rent_transactions, asb_reports, inspections, voids, compliance_certificates, documents, notices, checkins |
curl https://api.housing-iq.com/v1/export/repairs \
-H "Authorization: Bearer $HOUSING_IQ_KEY"