Skip to main content

Introduction

The Homesoon Third-Party API lets partners integrate their systems with Homesoon workspaces — manage constructions, tasks, appointments, supervisors, and Shabelabo voice-minute records.

Base URL​

EnvironmentURL
Productionhttps://api.homesoon.jp/api
Staginghttps://staging.api.homesoon.jp/api
Developmenthttps://develop.api.homesoon.jp/api

All endpoints live under the /v1/third-party/ prefix.

Conventions​

  • Every response is wrapped: 
    {"status": "success", "data": {...}, "meta": {...}, "error": null}
  • Errors flip status to "failure" and put the diagnostic in error.
  • Timestamps are ISO 8601, UTC.
  • Pagination uses page (1-based) and paging (page size, max 100).

Next steps​

  1. Register your origin — see Authentication.
  2. Try POST /v1/third-party/refresh_tokens to mint an access token.
  3. Browse the API Reference for endpoint details.