Get started
Build across the property journey.
Use the Homejourney Platform API to connect organizations, real estate professionals, property inventory, partner workflows, and event-driven integrations.
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