Developers
API reference
The Sakneen API is a REST interface over the same records the product uses: units, projects, developers, offers, reservations and payment schedules. Access is authenticated per customer and scoped by the same permissions that govern the application, including field-level restrictions.
Resources
Field names match the unit record schema, so the documentation and the payload agree.
| Resource | Returns | Scope |
|---|---|---|
| /units | Unit records: identity, geometry, specification, position, commercial terms, availability, delivery | Projects the caller is entitled to |
| /projects | Project and phase metadata, release state, masterplan geometry references | Projects the caller is entitled to |
| /developers | Developer profile and the projects it publishes | Public and entitled projects |
| /offers | Offers issued, with the unit state they were issued against | The caller's own offers |
| /reservations | Reservations and their payment status | The caller's own reservations |
| /schedules | Instalment schedules and payment history | The caller's own clients |
API connection details are shared during integration onboarding. Contact Sakneen to discuss authentication, supported operations and your implementation requirements.
Conventions
- Authentication
- Bearer token issued per customer, scoped to that customer's entitlements.
- Identifiers
- Every unit carries a stable Sakneen identifier alongside the developer's own unit code.
- Versioning
- Unit state is versioned, so an offer can be resolved against the record as it stood when issued.
- Permissions
- Field-level restrictions apply to tokens exactly as they apply to users.
Frequently asked questions
- Can we write to the API?
- Write access is granted selectively, typically for availability and reservation state from a CRM. Most integrations read.
- Are webhooks available?
- Event delivery for availability and reservation changes is available to integration customers. Confirm the event list during implementation.
Related
See it against your own inventory
Bring one project. We load its masterplan and unit list, and you see your own homes as digital records before you decide anything.