GET
Landlord autocomplete

Overview

Returns the curated list of UK councils and housing associations the client offers as autocomplete suggestions on the step-1 “Who is your landlord?” tenancy form. This is a reference lookup only — it does not verify anything; a human admin reviews the uploaded tenancy document. Pass an optional q to filter by name as the user types, and an optional type to restrict to councils or housing associations. Only active landlords are returned, name-sorted, capped at 20 rows. The list is populated by the pnpm seed:landlords script (a vendored data file mirroring the Regulator of Social Housing register — ~1,580 councils + private registered providers) and curated by admins via the admin landlords endpoints. When the user’s landlord is not in the list, the client falls back to the free-text landlordName field on step 1 with landlordId: null.

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

Request body

None.

Response — 200 OK

Example response

Error responses

Side effects

None — this is a pure read.

See also

curl