Introduction to Amulet APIs
Source-reviewed draft; deployment and release verification pending.
Draft — reviewed against repository source on 22 October 2026. Deployment and live service availability have not been verified.
Amulet Developer Hub is the integration documentation home for Amulet Property Investments. Its first API definition is the Website Property API — Feature 110, which lets a website search eligible property listings, display property details and approved images, and read controlled reference values.
The hub is designed to hold multiple API definitions and integration sections within one ReadMe project. Future APIs should get their own scoped definition and guides here, rather than a separate developer hub or access to the complete CRM contract.
What the first API supports
| Capability | Current source behavior |
|---|---|
| Property listings | Anonymous search by operation, map geometry and supported filters; paginated public summaries. |
| Property details | A public detail projection, operation-specific pricing and optional public agent contact card. |
| Map search | Bounds and simple polygons over permitted public points for the Tenerife destination. |
| Reference values | Destination extent, physical classification values, views, rental types, climate zones, active catalogs and city-scoped LocalAreas. |
| Media | Sanitized property images and eligible public agent images through dedicated public routes. |
These pages describe implemented source behavior, not a production deployment announcement. Website catalog keys still need agreement with the website team before external deployment. Read Classifications and catalogs before hardcoding navigation.
Supported integrations versus future documentation
Only the Website Property API operations reviewed in this draft are documented for external consumers. Other integrations in the Amulet ecosystem, including lead providers, communications, calendars and property portals, do not gain a public API contract through this document. Rental, reservation, enquiry, partner and mobile APIs may be added later after their own scope and security review. Their availability, authentication and schemas must not be inferred from Feature 110.
Start designing the website
- Read Environments and authentication, then Website integration overview.
- Design cards from the summary DTO and detail pages from the detail DTO in Public Property model.
- Treat absent values as unknown. Avoid inventing exact addresses, prices or contact information.
- Load reference metadata before presenting dynamic catalog and LocalArea choices.
- Use synthetic fixtures until an approved environment and access arrangements are supplied.
Component view models may reshape the API for display; they are not additional API fields. A card's display heading, for example, may be a UI fallback derived from name and public_id; the API does not promise a title property.
Related operations
POST /api/v1/public/properties/searchGET /api/v1/public/properties/{public_id}GET /api/v1/public/property-referenceGET /api/v1/public/properties/{public_id}/images/{asset_id}GET /api/v1/public/agent-images/{asset_id}
Updated 1 day ago