ベータ版完全なリファレンスは正式リリース時に公開
自社サイトに、OmniPMのライブデータを。物件・空室・問い合わせを、ひとつのAPIで。
Webサイトも制作パートナーも今のままで。物件、賃料、実際の空室状況をOmniPMから直接読み込み、問い合わせ・内見予約・チャットはすべてチームの受信箱に届きます。
GET /properties?area=Mitaka&moveInBy=2026-11-01
Authorization: Bearer <your-website-key>
200 OK
{
"ok": true,
"data": {
"properties": [
{
"unitSlug": "mitaka-garden-204",
"buildingName": "Mitaka Garden",
"unitName": "204",
"type": "apartment",
"nearestStation": { "name": "Mitaka", "walkMinutes": 6 },
"price": 118000,
"size": { "sqm": 25.4, "layout": "1K", "floor": 2 },
"availability": {
"status": "available-from",
"date": "2026-11-01T00:00:00.000Z",
"label": "From Nov 1, 2026"
}
}
],
"pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}
}
- 認証
- サイトごとのBearerキー
- 形式
- HTTPS経由のJSON
- データ範囲
- 自社のデータのみ
- 制限
- キーごとにレート制限
- リファレンス
- 正式リリース時に公開
Webサイト用API
賃貸サイトに必要なものを、チームが毎日使うダッシュボードから。
OmniPMで賃料を変える、キャンペーンを始める、退去予告を登録する。次のリクエストから、Webサイトにそのまま反映されます。転記は不要です。
物件一覧と検索
エリア、アパート／シェアハウス、間取り、寝室数、賃料の範囲、入居希望日、実施中のキャンペーンで絞り込み。建物名・エリア・駅名での検索は、表記ゆれにも対応します。
areatypelayoutsbedroomspriceMinpriceMaxmoveInByavailableNowhasCampaignsortsearch物件詳細ページ
賃料、光熱費、建物管理費、広さと階数、最寄り駅と徒歩分数、設備、写真、実施中のキャンペーン、似た物件まで。
問い合わせは受信箱へ
問い合わせ、内見予約、ウェイティングリストへの登録、お問い合わせフォームは、対象の部屋に紐づいた会話としてOmniPMに届きます。
Webチャット
サイト上のAIチャットが最新の物件を検索し、ゲスト向けナレッジベースをもとに回答します。1回の回答で1クレジットを使います。
自社のコンテンツ
OmniPMで作成したブログ記事、キャンペーン、求人情報を、そのまま自社のページに掲載できます。
問い合わせを、そのまま受信箱へ
部屋のスラッグを送れば、OmniPMがその建物・部屋の問い合わせとして登録します。スラッグがない、または一致しない場合も、名前から照合するので問い合わせを取りこぼしません。
POST /inquiries
Authorization: Bearer <your-website-key>
Content-Type: application/json
{
"name": "Mara Lindqvist",
"email": "mara@example.com",
"platform": "website",
"unitSlug": "mitaka-garden-204",
"moveInDate": "2026-11-01",
"desiredPeriod": "6 months",
"message": "Is the desk by the window included?",
"locale": "en"
}
200 OK
{
"ok": true,
"data": {
"id": "…",
"matched": {
"building": { "id": "…", "name": "Mitaka Garden" },
"unit": { "id": "…", "name": "204" }
}
}
}
APIの全体像
/properties空室のある部屋を絞り込み・ページ分けして取得。各部屋に空室状況つきproperties:read/properties?search={term}建物名・エリア・駅名で検索し、結果を一文で返すproperties:read/properties/{id}部屋の詳細：写真、費用、キャンペーン、似た物件properties:read/buildings/{id}建物ページ：部屋の一覧と所在地properties:read/content/{type}ブログ記事、キャンペーン、求人情報content:read/inquiries問い合わせを部屋と照合し、受信箱に登録inquiries:write/leads/{kind}内見予約、ウェイティングリスト、お問い合わせ、ニュースレターleads:write/chatWebチャットの回答（1回につき1クレジット）chat:invoke/eventsマーケティング分析用のページビューと検索analytics:writeパスは一般的な形で表記しています。すべてのフィールド、絞り込み条件、エラーを例とともに載せた完全なリファレンスは、正式リリース時に公開します。
リアルタイムの空室状況
空室状況は、算出済みの状態で届きます。サイト側がカレンダーから推測する必要はありません。
OmniPMはリクエストのたびに、予約と契約から各部屋の空室状況を算出し、ステータス、日付、そのまま表示できるラベルを返します。「空室あり」として掲載されるのは、現在空いている部屋か、退去予告で日付が確定している部屋だけです。
4つの部屋、4つの答え
デモの部屋 · 本日＝10月10日available-nowAvailable Nowavailable-fromFrom Nov 1, 2026possibly-fromPossibly from Dec 12, 2026occupiedOccupiedavailable-now掲載即入居可
現在空室で、すぐに入居できます。
available-from掲載入居可能日あり
入居者が退去予告を提出済みのため、日付が確定しています。
possibly-from検索時のみ入居できる可能性あり
定期契約の満了が近いものの、退去予告は未提出で、更新される可能性があります。検索時にのみ、別枠で返します。
occupied件数のみ入居中
空室の予定はありません。検索結果では件数のみ数え、掲載はしません。
検索結果を、一文で。
建物名、エリア、駅名で検索すると、4つの結果のどれに当たるかと、サイトやチャットボットでそのまま表示できる一文が返ります。
available空室が1部屋以上あります。2 units available for "Mitaka".possibly_available今は空いていないものの、空く可能性があります。No units are available now for "Kanda", but 2 units may become available: …none_available物件は存在しますが、満室です。"Ebisu Studio" exists but has no units available right now.not_found一致する建物・エリア・駅がありません。No listing matching "Odaiba Bay" was found.// On every unit the API returns
"availability": {
"status": "possibly-from",
"date": "2026-12-12T00:00:00.000Z",
"dateUntil": null,
"label": "Possibly from Dec 12, 2026"
}
GET /properties?search=Kanda
Authorization: Bearer <your-website-key>
200 OK
{
"ok": true,
"data": {
"properties": [],
"possiblyAvailable": [ … ],
"search": {
"term": "Kanda",
"outcome": "possibly_available",
"message": "No units are available now for \"Kanda\", but 2 units …",
"matchTier": "exact",
"availableCount": 0,
"possiblyAvailableCount": 2,
"occupiedCount": 9
}
}
}
APIキー
Webサイトごとに、専用のキー。必要な権限だけを付け、ワンクリックで無効化。
キーはダッシュボードの「設定」から作成します。キーは自社だけに紐づくため、そのキーによるリクエストはすべて自社の建物・部屋に限定されます。
API keys
Bearer keys for your websites. A key is shown once, when you create it.
Key for “Ebisu Studio landing page” — copy it now. It won’t be shown again.
••••••••••••••••••••••••••••a91F
- 01
Bearer認証
キーはHTTPS経由で、Authorizationヘッダーに入れてサーバーから送信します。訪問者のブラウザで動くコードには含めないでください。
- 02
スコープで権限を限定
物件の読み取り、コンテンツの読み取り、問い合わせ・フォームの送信、チャット、分析データの送信から、サイトに必要なものだけを付与します。範囲外のリクエストは拒否されます。
- 03
表示は一度だけ、保存はハッシュで
キーの全体が表示されるのは作成時の一度だけです。OmniPMはハッシュしか保存しないため、私たちを含め誰も再表示できません。
- 04
いつでも無効化
無効化したキーは、次のリクエストから拒否されます。最終利用日時で、使われているキーがひと目でわかります。
- 05
レート制限
キーごとにリクエストの上限があるため、アクセスの多いサイトが他のサイトを遅くすることはありません。上限を超えると、Retry-Afterヘッダー付きの429を返します。
リクエストが拒否されたとき
エラーは一般的なステータスコードと、英語のわかりやすいメッセージを含むJSONで返ります。
# No key, or a revoked one
401 Unauthorized
{ "error": "API key revoked" }
# A key without the scope this endpoint needs
403 Forbidden
{ "error": "Missing required scope: inquiries:write" }
# Over this key's request budget
429 Too Many Requests
Retry-After: <seconds>
{ "error": "Too many requests. Please try again later." }
先行アクセス
ドキュメントは準備中です。ベータ参加事業者は、今から一緒に開発できます。
開発者の方からのよくある質問
APIの利用に追加料金はかかりますか？
かかりません。APIは全プランに含まれ、自社サイトとの連携にも追加費用はありません。Webチャットの回答は、他のAI機能と同じくAIクレジットを使います。
空室状況はリアルタイムですか？
リクエストのたびに、予約と契約から算出しています。サイト側でレスポンスをキャッシュしている場合は、キャッシュした時点の内容が表示されます。
サイトから予約を受け付けられますか？
サイトからは、問い合わせ、内見予約、ウェイティングリストへの登録をOmniPMに送れます。予約の確定はOmniPMで行います。チームが確定するか、金額と有効期限を設定した予約リンクからゲストが手続きします。
データは何語で返りますか？
建物名、部屋名、エリア名、駅名は英語と日本語の両方で返ります。どう表示するかはサイト側で決められます。
ひとつのキーで複数のサイトに対応できますか？
可能ですが、サイトごとにキーを分けることをおすすめします。1つを無効化しても他のサイトは動き続け、最終利用日時でどのサイトからの利用かもわかります。
完全なリファレンスはいつ公開されますか？
正式リリース時に公開します。それまでは、ベータ参加事業者に実際のリファレンスを共有し、APIの開発チームが直接サポートします。