Admin landlords list
Landlords
Admin landlords list
List / search the curated landlords reference list (councils + housing associations).
GET
Admin landlords list
Overview
Lists the curated landlords reference list used by the onboarding landlord autocomplete. Unlike the onboarding endpoint, this admin view includes inactive rows and supports pagination. Available to any admin role — read-only. The list is first populated by thepnpm seed:landlords script (a vendored data file mirroring the Regulator of Social Housing register — ~1,580 councils + private registered providers) and then curated here.
Authentication
Bearer <accessToken> with scope: 'admin' required (requireAdmin).
Query parameters
| Name | Type | Required | Notes | Example |
|---|---|---|---|---|
q | string | no | Case-insensitive substring match on the name (1..100 chars). | camden |
type | enum | no | COUNCIL or HOUSING_ASSOCIATION. | COUNCIL |
active | boolean | no | Filter by active flag. Omit for all. | false |
limit | integer | no | Page size, 1..100. Default 25. | 50 |
skip | integer | no | Offset for pagination. Default 0. | 50 |
Response — 200 OK
| Field | Type | Notes |
|---|---|---|
items | array | Landlord rows (below), name-sorted. |
total | integer | Total matching the filter (across all pages). |
Landlord row
| Field | Type | Notes |
|---|---|---|
id | string | Landlord ObjectId. |
name | string | Canonical name. |
type | enum | COUNCIL | HOUSING_ASSOCIATION. |
active | boolean | Inactive rows are hidden from the onboarding autocomplete. |
createdAt | string | ISO timestamp. |
updatedAt | string | ISO timestamp. |
Error responses
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_FAILED | Bad type, active, limit, or skip. |
| 401 | UNAUTHENTICATED | Missing, malformed, expired, or non-admin-scope token. |