Homejourney API

Homejourney API as documented publicly: 17 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

GitHub OpenAPI

Operations 17

GET /agents/current GET /agents/current #
GET /developers/current/projects List sandbox developer projects #
GET /listing-feed/listings Read listings from the feed (listings.read). #
DELETE /listing-feed/listings/{externalref} Delete a feed listing (listings.write). #
GET /listing-feed/listings/{externalref} Read a specific feed listing (listings.read). #
PUT /listing-feed/listings/{externalref} Send your agency’s listing (listings.write). #
GET /listings GET /listings #
GET /listings/{id} Read a single listing by its ID (listings.read). #
POST /onboarding/evidence POST /onboarding/evidence for each item #
POST /onboarding/live-access/request POST /onboarding/live-access/request #
GET /onboarding/readiness GET /onboarding/readiness lists what is still missing #
GET /organizations/current Inspect the current platform organization​ #
GET /products GET /products #
GET /sites List sandbox partner sites #
GET /v1/organizations/current GET /v1/organizations/current #
GET /webhooks/endpoints GET /webhooks/endpoints #
GET /workspaces/current GET /workspaces/current #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/homejourney-sg:homejourney-sg-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

homejourney-sg-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Homejourney API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 17 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Homejourney has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 16
    pages-with-code: 2
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.homejourney.sg/api/platform/v1/docs
  - https://www.homejourney.sg/api/platform/v1/openapi.json
  - https://www.homejourney.sg/api-docs
  - https://www.homejourney.sg/llms.txt
servers:
- url: https://platform-api.homejourney.sg/v1
paths:
  /agents/current:
    get:
      operationId: get_agents_current
      tags:
      - Agents
      summary: GET /agents/current
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /developers/current/projects:
    get:
      operationId: get_developers_current_projects
      tags:
      - Developers
      summary: List sandbox developer projects
      description: 'Returns deterministic sandbox developer project summaries when the authenticated automation client has `developers.projects.read`.
        External URL: `/v1/developers/current/projects`. This read-only route includes source attribution, freshness labels, public-safe unit-type
        availability, redaction evidence, and side-effect blocking.'
      x-source: https://www.homejourney.sg/api/platform/v1/openapi.json
      parameters:
      - name: Correlation-Id
        in: header
        required: false
        schema:
          type: string
        description: Correlation identifier for request tracing.
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Maximum number of sandbox developer projects to return.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Opaque pagination cursor from a previous response.
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by sandbox developer project status.
      - name: freshness_status
        in: query
        required: false
        schema:
          type: string
        description: Filter by source freshness label.
      - name: source_precedence
        in: query
        required: false
        schema:
          type: string
        description: Filter by the winning developer inventory source class.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDevelopersCurrentProjectsResponse'
      x-evidence:
        kind: documentation
  /listing-feed/listings:
    get:
      operationId: get_listing_feed_listings
      tags:
      - Listing Feed
      summary: Read listings from the feed (listings.read).
      x-source: https://www.homejourney.sg/llms.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /listing-feed/listings/{externalref}:
    delete:
      operationId: delete_listing_feed_listings_externalref
      tags:
      - Listing Feed
      summary: Delete a feed listing (listings.write).
      x-source: https://www.homejourney.sg/llms.txt
      parameters:
      - name: externalref
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_listing_feed_listings_externalref
      tags:
      - Listing Feed
      summary: Read a specific feed listing (listings.read).
      x-source: https://www.homejourney.sg/llms.txt
      parameters:
      - name: externalref
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_listing_feed_listings_externalref
      tags:
      - Listing Feed
      summary: Send your agency’s listing (listings.write).
      x-source: https://www.homejourney.sg/llms.txt
      parameters:
      - name: externalref
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /listings:
    get:
      operationId: get_listings
      tags:
      - Listings
      summary: GET /listings
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /listings/{id}:
    get:
      operationId: get_listings_id
      tags:
      - Listings
      summary: Read a single listing by its ID (listings.read).
      x-source: https://www.homejourney.sg/llms.txt
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /onboarding/evidence:
    post:
      operationId: post_onboarding_evidence
      tags:
      - Onboarding
      summary: POST /onboarding/evidence for each item
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /onboarding/live-access/request:
    post:
      operationId: post_onboarding_live_access_request
      tags:
      - Onboarding
      summary: POST /onboarding/live-access/request
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /onboarding/readiness:
    get:
      operationId: get_onboarding_readiness
      tags:
      - Onboarding
      summary: GET /onboarding/readiness lists what is still missing
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /organizations/current:
    get:
      operationId: get_organizations_current
      tags:
      - Organizations
      summary: Inspect the current platform organization​
      x-source: https://www.homejourney.sg/api/platform/v1/docs
      parameters:
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
        description: Optional partner-provided correlation ID echoed into request evidence.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrganizationsCurrentResponse'
      x-evidence:
        kind: documentation
  /products:
    get:
      operationId: get_products
      tags:
      - Products
      summary: GET /products
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /sites:
    get:
      operationId: get_sites
      tags:
      - Sites
      summary: List sandbox partner sites
      description: 'Returns deterministic sandbox partner-site summaries when the authenticated automation client has `sites.read`. External URL:
        `/v1/sites`. This read-only route does not require `Idempotency-Key`; it never renders public pages, publishes sites, writes CRM records,
        performs scheduling side effects, configures custom domains, or exposes partner secrets.'
      x-source: https://www.homejourney.sg/api/platform/v1/openapi.json
      parameters:
      - name: Correlation-Id
        in: header
        required: false
        schema:
          type: string
        description: Correlation identifier for request tracing.
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Maximum number of sandbox site summaries to return.
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Opaque pagination cursor from a previous response.
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by sandbox site publication status.
      - name: template_id
        in: query
        required: false
        schema:
          type: string
        description: Filter by approved sandbox site template.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSitesResponse'
      x-evidence:
        kind: documentation
  /v1/organizations/current:
    get:
      operationId: get_v1_organizations_current
      tags:
      - Organizations
      summary: GET /v1/organizations/current
      x-source: https://www.homejourney.sg/api/platform/v1/docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://platform-api.homejourney.sg/v1/organizations/current  --header ''Authorization: Bearer YOUR_SECRET_TOKEN''

          Test Request

          (get /organizations/current)

          STATUS:

          200

          CURRENT ORGANIZATION AND CREDENTIAL CONTEXT.

          STATUS:

          400

          REQUEST VALIDATION FAILED.

          STATUS:

          401

          MISSING OR INVALID PLATFORM API KEY.

          STATUS:

          403

          CREDENTIAL, ENVIRONMENT, OR SCOPE IS NOT ALLOWED.

          STATUS:

          404

          PLATFORM API FEATURE '
  /webhooks/endpoints:
    get:
      operationId: get_webhooks_endpoints
      tags:
      - Webhooks
      summary: GET /webhooks/endpoints
      x-source: https://www.homejourney.sg/api-docs
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /workspaces/current:
    get:
      operationId: get_workspaces_current
      tags:
      - Workspaces
      summary: GET /workspaces/current
      x-source: https://www.homejourney.sg/api/platform/v1/docs
      parameters:
      - name: X-Correlation-Id
        in: header
        required: false
        schema:
          type: string
        description: Optional partner-provided correlation ID echoed into request evidence.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspacesCurrentResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetDevelopersCurrentProjectsResponse:
      type: object
      properties:
        '200':
          type: string
          description: Sandbox developer project response.
    GetOrganizationsCurrentResponse:
      type: object
      properties:
        '200':
          type: string
          description: Current organization and credential context.
        '400':
          type: string
          description: Request validation failed.
        '401':
          type: string
          description: Missing or invalid platform API key.
        '403':
          type: string
          description: Credential, environment, or scope is not allowed.
        '404':
          type: string
          description: Platform API feature or resource is not available.
        '429':
          type: string
          description: Rate limit exceeded.
        '500':
          type: string
          description: Unexpected platform API failure.
    GetSitesResponse:
      type: object
      properties:
        '200':
          type: string
          description: Sandbox partner-site summaries.
    GetWorkspacesCurrentResponse:
      type: object
      properties:
        '200':
          type: string
          description: Current workspace and module state.
        '400':
          type: string
          description: Request validation failed.
        '401':
          type: string
          description: Missing or invalid platform API key.
        '403':
          type: string
          description: Credential, environment, or scope is not allowed.
        '404':
          type: string
          description: Platform API feature or resource is not available.
        '429':
          type: string
          description: Rate limit exceeded.
        '500':
          type: string
          description: Unexpected platform API failure.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Agents
- name: Developers
- name: Listing Feed
- name: Listings
- name: Onboarding
- name: Organizations
- name: Products
- name: Sites
- name: Webhooks
- name: Workspaces