HOUSING-iQHousing management system

API reference

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.

Organisation

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"

Properties

The homes your organisation manages.

The properties object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
schemestring, nullablecreate, updateThe scheme or estate the home belongs to.
address_line1stringcreate (required), updateFirst line of the address.
address_line2string, nullablecreate, updateSecond line of the address.
citystring, nullablecreate, updateTown or city.
postcodestringcreate (required), updateUK postcode.
property_typestring, nullable
flat, house, bedsit, bungalow, maisonette, room, other
create, updateKind of home.
bedroomsinteger, nullablecreate, updateNumber of bedrooms.
statusstring, nullable
occupied, void, unavailable
create, updateWhether the home is lived in.
latitudenumber, nullablecreate, updateLatitude.
longitudenumber, nullablecreate, updateLongitude.
formatted_addressstring, nullableread onlyThe full address on one line, when known.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
deleted_atdate-time, nullableread onlyWhen the record was removed. Removed records are only listed with include_deleted=true.
Example object
{
  "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
}

List properties

GET /v1/properties

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
include_deletedbooleanInclude removed records.
schemestringFilter by scheme. Separate several values with commas.
postcodestringFilter by postcode. Separate several values with commas.
property_typestring
flat, house, bedsit, bungalow, maisonette, room, other
Filter by property_type. Separate several values with commas.
statusstring
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"

Create a property

POST /v1/properties

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a property

GET /v1/properties/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/properties/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a property

PATCH /v1/properties/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Remove a property

DELETE /v1/properties/{id}

Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.

ParameterTypeDescription
id pathid
curl -X DELETE https://api.housing-iq.com/v1/properties/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Tenants

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.

The tenants object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
first_namestringcreate (required)First name.
last_namestringcreate (required)Last name.
emailstringcreate (required)Email address, used to sign in and for email updates.
languagestring, nullableread onlyLanguage the tenant uses the app in (en, pl, ro, so, ur, ar).
is_activebooleanread onlyFalse when the account has been deactivated.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List tenants

GET /v1/tenants

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
emailstringFilter by email. Separate several values with commas.
is_activebooleanFilter by is_active. Separate several values with commas.
curl https://api.housing-iq.com/v1/tenants?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Create a tenant

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.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a tenant

GET /v1/tenants/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/tenants/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Tenancies

Who lives where, on what kind of tenancy.

The tenancies object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
property_ididcreate (required)The home (see Properties).
tenant_ididcreate (required)The tenant (see Tenants).
household_idid, nullablecreate, updateThe household, when grouped.
start_datedate, nullablecreate, updateTenancy start date.
end_datedate, nullablecreate, updateTenancy end date, if ended.
tenancy_typestring, nullable
secure, assured, starter, temporary, emergency, licence
create, updateKind of tenancy.
is_leadboolean, nullablecreate, updateThe lead tenant of the household.
weekly_chargenumber, nullablecreate, updateWeekly rent, in pounds.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
deleted_atdate-time, nullableread onlyWhen the record was removed. Removed records are only listed with include_deleted=true.
Example object
{
  "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
}

List tenancies

GET /v1/tenancies

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
include_deletedbooleanInclude removed records.
property_idstringFilter by property_id. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
tenancy_typestring
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"

Create a tenancy

POST /v1/tenancies

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a tenancy

GET /v1/tenancies/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/tenancies/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a tenancy

PATCH /v1/tenancies/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Remove a tenancy

DELETE /v1/tenancies/{id}

Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.

ParameterTypeDescription
id pathid
curl -X DELETE https://api.housing-iq.com/v1/tenancies/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Repairs

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.

The repairs object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
referencestring, nullableread onlyReference shown to the tenant, such as REP-0042.
tenant_ididcreate (required)The tenant (see Tenants).
property_idid, nullablecreate, updateThe home (see Properties).
categorystring
damp_mould, heating, plumbing, electrical, doors_windows, pests, safety_hazard, general
create (required), updateWhat needs repairing.
titlestringcreate (required), updateShort description.
descriptionstring, nullablecreate, updateFull description.
prioritystring, nullable
emergency, urgent, routine
create, updatePriority. Sets the repair target.
statusstring, nullable
new, triaged, assigned, scheduled, in_progress, completed, cancelled
updateWhere the repair has got to. The tenant is told of each change.
is_dampboolean, nullablecreate, updateDamp or mould is involved.
is_repeatboolean, nullableread onlyThe same problem has been reported before.
hazard_typestring, nullable
damp_mould, excess_cold, excess_heat, falls, structural_collapse, fire_explosion, electrical, domestic_hygiene, other_hhsrs
create, updateThe Awaab's Law hazard, if any.
hazard_classstring, nullable
none, significant, emergency
create, updateAwaab's Law class: an emergency hazard gets a 24-hour clock.
reported_atdate-time, nullableread onlyWhen the repair was reported.
target_datedate, nullableread onlyRepair target date (from your repair targets).
sla_due_atdate-time, nullableread onlyRepair target, as a time.
scheduled_fordate-time, nullableupdateBooked visit. The tenant is told.
completed_atdate-time, nullableread onlyWhen the repair was completed.
assigned_toid, nullableupdateThe officer responsible (a staff member id).
contractor_namestring, nullableupdateContractor contact name.
contractor_companystring, nullableupdateContractor company.
contractor_phonestring, nullableupdateContractor phone number, shown to the tenant.
awaab_aware_atdate-time, nullableread onlyWhen the landlord became aware (Awaab's Law clock start).
awaab_emergency_bydate-time, nullableread onlyEmergency hazards: make safe by (24 hours).
awaab_investigate_bydate, nullableread onlyInvestigate by (10 working days).
awaab_summary_bydate, nullableread onlyWritten summary to the tenant by (3 working days after investigating).
awaab_fix_bydate, nullableread onlyBegin safety work by (5 working days after investigating).
awaab_preventative_start_bydate, nullableread onlyStart further work by.
awaab_preventative_latestdate, nullableread onlyFurther work physically under way by (12 weeks).
awaab_investigated_atdate-time, nullableupdateWhen the investigation was done. The later deadlines follow from it.
awaab_summary_sent_atdate-time, nullableupdateWhen the written summary was sent.
awaab_safety_work_done_atdate-time, nullableupdateWhen the home was made safe.
awaab_preventative_started_atdate-time, nullableupdateWhen further work started.
ai_urgency_scoreinteger, nullableread onlyUrgency score (0 to 100) from the automatic triage, for staff to confirm.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List repairs

GET /v1/repairs

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
referencestringFilter by reference. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
property_idstringFilter by property_id. Separate several values with commas.
categorystring
damp_mould, heating, plumbing, electrical, doors_windows, pests, safety_hazard, general
Filter by category. Separate several values with commas.
prioritystring
emergency, urgent, routine
Filter by priority. Separate several values with commas.
statusstring
new, triaged, assigned, scheduled, in_progress, completed, cancelled
Filter by status. Separate several values with commas.
is_dampbooleanFilter by is_damp. Separate several values with commas.
curl https://api.housing-iq.com/v1/repairs?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Create a repair

POST /v1/repairs

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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
  }'

Retrieve a repair

GET /v1/repairs/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/repairs/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a repair

PATCH /v1/repairs/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

List a repair's history

GET /v1/repairs/{id}/events

ParameterTypeDescription
id pathid
limitinteger
starting_afterstring
curl https://api.housing-iq.com/v1/repairs/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12/events?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Repair events

Each repair's history: created, triaged, assigned, scheduled, status changes and completion.

The repair events object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
repair_ididread onlyThe repair.
event_typestring
created, ai_triage, status_change, note, scheduled, assigned, escalation, completed, priority_change, contractor
read onlyWhat happened.
actor_typestring
tenant, staff, ai, system
read onlyWho did it.
actor_idid, nullableread onlyThe person, when a person did it.
bodystring, nullableread onlyDetails.
created_atdate-timeread onlyWhen the record was created.
Example object
{
  "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"
}

List repair events

GET /v1/repair_events

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
repair_idstringFilter by repair_id. Separate several values with commas.
event_typestring
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"

Retrieve a repair event

GET /v1/repair_events/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/repair_events/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Complaints

Complaints, followed through both stages of the Housing Ombudsman's Complaint Handling Code. HOUSING-iQ sets the acknowledgement and reply deadlines in working days.

The complaints object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
referencestring, nullableread onlyReference, such as CMP-0012.
tenant_ididcreate (required)The tenant (see Tenants).
subjectstringcreate (required)What the complaint is about, in a line.
descriptionstringcreate (required)The complaint in full.
categorystring, nullable
repairs, anti_social_behaviour, staff, rent_and_charges, communication, neighbourhood, other
createCategory.
desired_outcomestring, nullablecreateWhat the tenant would like to happen.
channelstring, nullable
app, phone, in_person, letter, email, other
createHow the complaint was made.
received_atdate-time, nullablecreateWhen it was received (defaults to now).
stagestring, nullable
stage_1, stage_2, ombudsman
read onlyStage.
statusstring, nullable
open, acknowledged, responded, closed
read onlyStatus.
owner_idid, nullableupdateThe member of staff handling it.
stage1_acknowledge_bydate, nullableread onlyStage 1: acknowledge by.
stage1_acknowledged_atdate-time, nullableupdateStage 1: when acknowledged.
stage1_respond_bydate, nullableread onlyStage 1: reply by.
stage1_extended_todate, nullableupdateStage 1: extended reply date.
stage1_extension_reasonstring, nullableupdateStage 1: why the reply date was extended.
stage1_responded_atdate-time, nullableupdateStage 1: when the reply was sent.
stage1_responsestring, nullableupdateStage 1: the reply.
escalated_atdate-time, nullableread onlyWhen it went to stage 2.
escalation_reasonstring, nullableread onlyWhy it went to stage 2.
stage2_acknowledge_bydate, nullableread onlyStage 2: acknowledge by.
stage2_acknowledged_atdate-time, nullableupdateStage 2: when acknowledged.
stage2_respond_bydate, nullableread onlyStage 2: reply by.
stage2_extended_todate, nullableupdateStage 2: extended reply date.
stage2_extension_reasonstring, nullableupdateStage 2: why the reply date was extended.
stage2_responded_atdate-time, nullableupdateStage 2: when the reply was sent.
stage2_responsestring, nullableupdateStage 2: the reply.
closed_atdate-time, nullableread onlyWhen it was closed.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List complaints

GET /v1/complaints

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
referencestringFilter by reference. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
categorystring
repairs, anti_social_behaviour, staff, rent_and_charges, communication, neighbourhood, other
Filter by category. Separate several values with commas.
channelstring
app, phone, in_person, letter, email, other
Filter by channel. Separate several values with commas.
stagestring
stage_1, stage_2, ombudsman
Filter by stage. Separate several values with commas.
statusstring
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"

Create a complaint

POST /v1/complaints

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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."
  }'

Retrieve a complaint

GET /v1/complaints/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/complaints/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a complaint

PATCH /v1/complaints/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Cases

Casework: support, arrears, welfare, safeguarding and tenancy cases. Needs the sensitive scope.

The cases object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
referencestring, nullableread onlyReference, such as CASE-0007.
tenant_ididread onlyThe tenant (see Tenants).
case_typestring
rent_arrears, asb, welfare, repairs_related, safeguarding, complaint, tenancy, other
read onlyKind of case.
titlestringread onlyTitle.
summarystring, nullableread onlySummary written by staff.
prioritystring, nullable
p1, p2, p3, p4
read onlyPriority (p1 highest).
statusstring, nullable
open, in_progress, on_hold, closed
read onlyStatus.
risk_levelstring, nullable
low, medium, high
read onlyRisk level.
owner_idid, nullableread onlyCase owner.
opened_atdate-time, nullableread onlyOpened.
closed_atdate-time, nullableread onlyClosed.
outcomestring, nullable
resolved, signposted, no_action, escalated, withdrawn
read onlyOutcome.
closure_summarystring, nullableread onlySummary written when closing.
linked_repair_idid, nullableread onlyA linked repair.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List cases

GET /v1/cases

Newest first. Needs the read and sensitive scopes.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
referencestringFilter by reference. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
case_typestring
rent_arrears, asb, welfare, repairs_related, safeguarding, complaint, tenancy, other
Filter by case_type. Separate several values with commas.
prioritystring
p1, p2, p3, p4
Filter by priority. Separate several values with commas.
statusstring
open, in_progress, on_hold, closed
Filter by status. Separate several values with commas.
risk_levelstring
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"

Retrieve a case

GET /v1/cases/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/cases/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Appointments

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.

The appointments object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
tenant_ididcreate (required)The tenant (see Tenants).
titlestringcreate (required), updateWhat the appointment is.
appointment_typestring, nullable
repair_visit, support_visit, inspection, review, other
create, updateKind of appointment. repair_visit appointments come from repairs and cannot be created here.
scheduled_fordate-timecreate (required), updateWhen it is.
duration_minsinteger, nullablecreate, updateLength in minutes.
statusstring, nullable
requested, confirmed, completed, cancelled, missed
create, updateStatus.
locationstring, nullablecreate, updateWhere.
contractor_namestring, nullablecreate, updateWho is coming.
notesstring, nullablecreate, updateNotes for the tenant.
repair_idid, nullableread onlyFor repair visits: the repair.
cancel_reasonstring, nullableupdateWhy it was cancelled.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
deleted_atdate-time, nullableread onlyWhen the record was removed. Removed records are only listed with include_deleted=true.
Example object
{
  "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
}

List appointments

GET /v1/appointments

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
include_deletedbooleanInclude removed records.
tenant_idstringFilter by tenant_id. Separate several values with commas.
appointment_typestring
repair_visit, support_visit, inspection, review, other
Filter by appointment_type. Separate several values with commas.
statusstring
requested, confirmed, completed, cancelled, missed
Filter by status. Separate several values with commas.
repair_idstringFilter by repair_id. Separate several values with commas.
curl https://api.housing-iq.com/v1/appointments?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Create a appointment

POST /v1/appointments

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a appointment

GET /v1/appointments/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/appointments/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a appointment

PATCH /v1/appointments/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Rent accounts

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.

The rent accounts object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
tenant_ididcreate (required)The tenant (see Tenants).
tenancy_idid, nullablecreateThe tenancy.
balancenumber, nullableread onlyAmount owed, in pounds (negative means in credit).
weekly_chargenumber, nullablecreate (required), updateWeekly rent, in pounds.
next_due_datedate, nullablecreate, updateWhen rent is next added. Cannot be in the past.
payment_plan_notestring, nullableupdateNote on any payment plan.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List rent accounts

GET /v1/rent_accounts

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
tenant_idstringFilter 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"

Create a rent account

POST /v1/rent_accounts

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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
  }'

Retrieve a rent account

GET /v1/rent_accounts/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/rent_accounts/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a rent account

PATCH /v1/rent_accounts/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Rent transactions

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.

The rent transactions object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
rent_account_ididcreate (required)The rent account.
tenant_ididread onlyThe tenant (taken from the rent account).
amountnumbercreate (required)Amount in pounds: positive adds to what is owed, negative reduces it.
txn_typestring
charge, payment, adjustment, housing_benefit
create (required)Kind of line.
statusstring, nullable
confirmed, pending, disputed
read onlyLines you record are confirmed; payments tenants log wait for staff to check.
descriptionstring, nullablecreateWhat the line is for (required for adjustments).
occurred_ondate, nullablecreateDate of the payment or charge (up to a year back, not in the future).
charge_fordate, nullableread onlyFor weekly rent added by HOUSING-iQ: the week it is for.
recorded_byid, nullableread onlyWho recorded it.
created_atdate-timeread onlyWhen the record was created.
Example object
{
  "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"
}

List rent transactions

GET /v1/rent_transactions

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
rent_account_idstringFilter by rent_account_id. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
txn_typestring
charge, payment, adjustment, housing_benefit
Filter by txn_type. Separate several values with commas.
statusstring
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"

Create a rent transaction

POST /v1/rent_transactions

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a rent transaction

GET /v1/rent_transactions/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/rent_transactions/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Anti-social behaviour reports

ASB reports. The diary that goes with each report cannot be changed and is not available through the API. Needs the sensitive scope.

The anti-social behaviour reports object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
referencestring, nullableread onlyReference.
tenant_ididread onlyThe tenant (see Tenants).
categorystringread onlyKind of behaviour.
descriptionstringread onlyWhat happened.
locationstring, nullableread onlyWhere.
involvesstring, nullable
residents, external, both, unknown
read onlyWho was involved.
statusstring, nullable
open, investigating, resolved, closed
read onlyStatus.
risk_levelstring, nullable
standard, medium, high
read onlyRisk level.
hate_incidentboolean, nullableread onlyRecorded as a hate incident (TSM NM01).
owner_idid, nullableread onlyOfficer.
closure_summarystring, nullableread onlyWhat was done.
closed_atdate-time, nullableread onlyClosed.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List anti-social behaviour reports

GET /v1/asb_reports

Newest first. Needs the read and sensitive scopes.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
referencestringFilter by reference. Separate several values with commas.
tenant_idstringFilter by tenant_id. Separate several values with commas.
categorystringFilter by category. Separate several values with commas.
statusstring
open, investigating, resolved, closed
Filter by status. Separate several values with commas.
risk_levelstring
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"

Retrieve a asb report

GET /v1/asb_reports/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/asb_reports/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Inspections

Home inspections.

The inspections object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
property_ididcreate (required)The home (see Properties).
inspector_idid, nullablecreate, updateThe inspecting member of staff.
scheduled_fordate-time, nullablecreate, updateWhen.
statusstring, nullable
scheduled, in_progress, completed
updateStatus.
notesstring, nullablecreate, updateNotes.
completed_atdate-time, nullableread onlyWhen it was completed.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List inspections

GET /v1/inspections

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
property_idstringFilter by property_id. Separate several values with commas.
statusstring
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"

Create a inspection

POST /v1/inspections

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a inspection

GET /v1/inspections/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/inspections/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a inspection

PATCH /v1/inspections/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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

Empty homes, from vacant to let.

The empty homes object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
property_ididcreate (required)The home (see Properties).
vacated_ondate, nullablecreate, updateWhen the home became empty.
statusstring, nullable
vacant, works, ready, let
create, updateStatus.
days_vacantinteger, nullableread onlyDays empty (worked out for you).
allocation_notesstring, nullablecreate, updateAllocation notes.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List empty homes

GET /v1/voids

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
property_idstringFilter by property_id. Separate several values with commas.
statusstring
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"

Create a void

POST /v1/voids

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a void

GET /v1/voids/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/voids/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a void

PATCH /v1/voids/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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"
  }'

Compliance certificates

Gas, electrical, energy, fire risk and legionella certificates for each home.

The compliance certificates object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
property_ididcreate (required)The home (see Properties).
cert_typestring
gas_cp12, eicr, epc, fire_risk, legionella
create (required)Kind of certificate.
issued_ondate, nullablecreate, updateIssued.
expires_ondate, nullablecreate, updateExpires.
statusstring, nullable
valid, due_soon, expired
create, updateStatus.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List compliance certificates

GET /v1/compliance_certificates

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
property_idstringFilter by property_id. Separate several values with commas.
cert_typestring
gas_cp12, eicr, epc, fire_risk, legionella
Filter by cert_type. Separate several values with commas.
statusstring
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"

Create a compliance certificate

POST /v1/compliance_certificates

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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"
  }'

Retrieve a compliance certificate

GET /v1/compliance_certificates/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/compliance_certificates/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a compliance certificate

PATCH /v1/compliance_certificates/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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

Documents shared with tenants, and whether each has been signed. File contents are not available through the API.

The documents object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
tenant_ididread onlyThe tenant (see Tenants).
titlestringread onlyTitle.
categorystring, nullable
tenancy, certificate, guide, form, other
read onlyCategory.
requires_signatureboolean, nullableread onlyThe tenant is asked to sign it.
sign_statestring, nullable
none, requested, signed
read onlySignature status.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
Example object
{
  "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"
}

List documents

GET /v1/documents

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
tenant_idstringFilter by tenant_id. Separate several values with commas.
categorystring
tenancy, certificate, guide, form, other
Filter by category. Separate several values with commas.
sign_statestring
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"

Retrieve a document

GET /v1/documents/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/documents/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Notices

News and alerts shown to tenants in the app.

The notices object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
titlestringcreate (required), updateTitle.
bodystringcreate (required), updateText.
tonestring, nullable
info, warning, good_news
create, updateHow it is shown.
audiencestring, nullable
org, households, tenants
create, updateWho sees it.
audience_idslist of strings, nullablecreate, updateHousehold or tenant ids, when the audience is households or tenants.
published_atdate-time, nullablecreate, updateWhen it is shown from.
created_atdate-timeread onlyWhen the record was created.
updated_atdate-timeread onlyWhen the record last changed.
deleted_atdate-time, nullableread onlyWhen the record was removed. Removed records are only listed with include_deleted=true.
Example object
{
  "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
}

List notices

GET /v1/notices

Newest first. Needs the read scope.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
updated_sincedate-timeOnly records changed at or after this time. Use it to sync.
include_deletedbooleanInclude removed records.
curl https://api.housing-iq.com/v1/notices?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Create a notice

POST /v1/notices

Needs the write scope. Send an Idempotency-Key header to make retries safe.

ParameterTypeDescription
Idempotency-Key headerstringAny 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."
  }'

Retrieve a notice

GET /v1/notices/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/notices/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Update a notice

PATCH /v1/notices/{id}

Send only the fields to change. Needs the write scope.

ParameterTypeDescription
id pathid
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."
  }'

Remove a notice

DELETE /v1/notices/{id}

Sets deleted_at. The record is kept and can be listed with include_deleted=true. Needs the write scope.

ParameterTypeDescription
id pathid
curl -X DELETE https://api.housing-iq.com/v1/notices/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Wellbeing check-ins

Wellbeing check-ins from tenants and how staff responded. Needs the sensitive scope. Needs the sensitive scope.

The wellbeing check-ins object

FieldTypeWriteDescription
objectstringread onlyThe kind of object.
ididread onlyUnique identifier.
tenant_ididread onlyThe tenant (see Tenants).
moodstring
great, good, okay, low, struggling
read onlyMood.
stressinteger, nullableread onlyStress, 1 to 5.
lonelinessinteger, nullableread onlyLoneliness, 1 to 5.
sleepinteger, nullableread onlySleep, 1 to 5.
crisis_flaggedboolean, nullableread onlyMay signal a crisis.
responded_atdate-time, nullableread onlyWhen staff responded.
response_actionstring, nullable
spoke_to_tenant, visited, referred, emergency_services, left_message, no_answer
read onlyWhat staff did.
created_atdate-timeread onlyWhen the record was created.
Example object
{
  "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"
}

List wellbeing check-ins

GET /v1/checkins

Newest first. Needs the read and sensitive scopes.

ParameterTypeDescription
limitintegerHow many to return (1 to 100).
starting_afterstringThe next_cursor from the previous page.
created_afterdate-timeOnly records created after this time.
created_beforedate-timeOnly records created before this time.
tenant_idstringFilter by tenant_id. Separate several values with commas.
moodstring
great, good, okay, low, struggling
Filter by mood. Separate several values with commas.
crisis_flaggedbooleanFilter by crisis_flagged. Separate several values with commas.
curl https://api.housing-iq.com/v1/checkins?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Retrieve a checkin

GET /v1/checkins/{id}

ParameterTypeDescription
id pathid
curl https://api.housing-iq.com/v1/checkins/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Events

List events

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.

ParameterTypeDescription
afterstringOnly events after this event id.
sincedate-timeOnly events at or after this time.
typestringEvent types, separated by commas.
limitinteger
curl https://api.housing-iq.com/v1/events?limit=2 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Retrieve an event

GET /v1/events/{id}

ParameterTypeDescription
id pathstring
curl https://api.housing-iq.com/v1/events/6f1c2b4e-8a3d-4c55-9e21-3b7d0a9f4c12 \
  -H "Authorization: Bearer $HOUSING_IQ_KEY"

Export

Export every record as NDJSON

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.

ParameterTypeDescription
resource pathstring
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"