myKutir Public API
Read-only integration API for a single society, scoped by API key. Each key belongs to one society and carries one or more scopes (e.g. flats:read); a request must present a key that has every scope required by the endpoint it calls.
Authentication
Every request (except this reference and /ping's health-check purpose aside) must include an X-Api-Key header with a key issued from Platform Console → Society 360 → Access. Each key is scoped to one society and one or more permission scopes.
/api/v1/pingVerifies the API key is valid and returns the society/label it belongs to. No data access beyond confirming the key.
Required scope: ping:read
/api/v1/flatsFlats belonging to the API key's society, optionally filtered by a search term matching flat number or block.
Required scope: flats:read
| Param | In | Type |
|---|---|---|
| search | query | string |
/api/v1/residentsActive residents of the API key's society, optionally filtered by a search term matching name, email, phone, flat number, or block.
Required scope: residents:read
| Param | In | Type |
|---|---|---|
| search | query | string |
/api/v1/maintenance/billsMaintenance bills for the API key's society, optionally filtered by month, year, status, or flat.
Required scope: maintenance:read
| Param | In | Type |
|---|---|---|
| month | query | integer |
| year | query | integer |
| status | query | string |
| flatId | query | string |
Machine-readable spec: /api/v1/openapi.json (OpenAPI 3.0)