Get started
Build across the property journey.
Use the Homejourney Platform API or AI Connect MCP endpoint to connect organizations, property journeys, professional workspaces, and compatible AI clients.
AI Connect
Connect any compatible AI client.
Homejourney exposes one standards-based MCP endpoint for AI clients. Tool access is governed by OAuth scopes and the user's authorized Homejourney workspace, not by host-specific integrations.
Hosted Streamable HTTP MCP endpoint
https://ai-apps.homejourney.sg/mcpAuthorize with OAuth
Authorization code, dynamic client registration, and S256 PKCE for public clients. Bearer tokens carry the approved scopes.
Keep access proportional
Public-safe reads can remain unauthenticated. Private reads and writes require the matching account, role, workspace, and consent.
Confirm consequential work
Write tools declare their behavior and retain Homejourney confirmation, idempotency, audit, and owned handoff controls.
Connection sequence
- 1.Add the hosted MCP endpoint to any compatible AI client.
- 2.The client discovers Homejourney OAuth and registers as a public PKCE client.
- 3.Homejourney requests only the scopes needed for protected tools.
- 4.The client calls tools within their read, write, and confirmation annotations.
- 5.Users can review and revoke connected AI access from Homejourney settings.
Discovery documents
Access and safety boundaries
- Public discovery returns public-safe Singapore property, service, finance, and news data.
- Private data and workspace tools require a signed-in Homejourney account and matching OAuth scopes.
- Consequential actions require explicit confirmation, idempotency, and Homejourney audit controls.
- Identity checks, sensitive consent, and payments continue on Homejourney-owned pages.
Integration and review support: support@homejourney.sg
Quickstart
Make your first request
Create a sandbox key in the API Console, then request the organization attached to that credential. Sandbox and live credentials are always isolated.
curl https://sandbox-platform-api.homejourney.sg/v1/organizations/current \
-H "Authorization: Bearer hjp_test_your_key" \
-H "Accept: application/json"Authentication
Use scoped bearer credentials
Send your platform API key in the Authorization header. Never expose a live key in client-side code or commit it to your repository.
Authorization header
Authorization: Bearer hjp_test_your_keyEnvironments
Develop safely in the sandbox
Sandbox credentials use deterministic test fixtures and cannot authenticate against live hosts. Move to live access only after integration review.
Sandbox
hjp_test_https://sandbox-platform-api.homejourney.sg/v1Live
hjp_live_https://platform-api.homejourney.sg/v1Platform APIs
One API for connected property operations
Start with the surface closest to your product, then follow its scopes and related workflows in the REST reference.
Organizations
Start with account context
Resolve the organization, credential environment, scopes, products, and onboarding readiness for an integration.
GET /organizations/currentProperty products
Connect real estate workflows
Build on listings, partner sites, official-source datasets, viewings, mortgage journeys, and service operations.
GET /productsAgents and agencies
Power professional workspaces
Read sandbox-safe listings, teams, analytics, viewings, distribution, and integration readiness.
GET /agents/currentDeveloper inventory
Publish and coordinate projects
Work with projects, unit types, inventory batches, price lists, media, showflat slots, and lead routing.
GET /developers/current/projectsWebhooks
React to platform events
Register endpoints, inspect delivery evidence, create sandbox test events, and safely replay deliveries.
GET /webhooks/endpointsReady to go deeper?
Explore every operation.
The interactive reference is generated from the same OpenAPI contract used by our SDK, CLI, and platform adapters.
Open REST API reference