Lewati ke konten utama

API reference v1

Halaman ini disinkronkan dari kontrak OpenAPI aktif. Method dan path di bawah adalah coverage reference; schema lengkap tersedia di openapi.json. Gunakan placeholder dan environment aman.

Konvensi​

  • Semua path di bawah memakai prefix function sesuai OpenAPI; jangan menghapus prefix ketika membuat request.
  • Authorization, idempotency, pagination, error, dan rate limit mengikuti schema dan response contract.
  • Tidak semua endpoint berarti akses publik untuk semua akun; credential dan capability tetap menentukan.

GET /api-availability/api/v1/spaces/{space_id}/availability​

GET /api-availability/api/v1/spaces/{space_id}/availability
Get 24-hour availability.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
space_idpathYastring (uuid)
datequeryYastring

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

DELETE /api-blocks/api/v1/spaces/{space_id}/blocks​

DELETE /api-blocks/api/v1/spaces/{space_id}/blocks
Delete host blocks.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Field request body

  • space_id — string
  • date — string
  • start_hour — number
  • end_hour — number

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

POST /api-blocks/api/v1/spaces/{space_id}/blocks​

POST /api-blocks/api/v1/spaces/{space_id}/blocks
Create host blocks.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Field request body

  • space_id — string
  • date — string
  • start_hour — number
  • end_hour — number
  • reason — string

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 200 — Success
  • 409 — BLOCK_SLOT_OCCUPIED

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-booking-detail/api/v1/bookings/{booking_id}​

GET /api-booking-detail/api/v1/bookings/{booking_id}
Get booking detail by booking_id.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
booking_idpathYastring (uuid)

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success
  • 404 — Not found

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-bookings/api/v1/bookings​

GET /api-bookings/api/v1/bookings
List host bookings.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
space_idqueryTidakstring (uuid)
statusqueryTidakstring
fromqueryTidakstring
toqueryTidakstring
limitqueryTidakinteger
offsetqueryTidakinteger

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

POST /api-cancel-booking/api/v1/bookings/{booking_id}/cancel​

POST /api-cancel-booking/api/v1/bookings/{booking_id}/cancel
Cancel booking via API.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
booking_idpathYastring (uuid)

Field request body

  • reason — string

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 200 — Success
  • 422 — BOOKING_CANCELLATION_BLOCKED | VALIDATION_ERROR

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

POST /api-create-booking/api/v1/bookings​

POST /api-create-booking/api/v1/bookings
Create booking via public API.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Field request body

  • space_id — string
  • date — string
  • start_hour — number
  • end_hour — number
  • guest_email — string
  • guest_name — string
  • guest_phone — string
  • settlement_mode — string
  • idempotency_key — string

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 200 — Success
  • 409 — BOOKING_CONFLICT
  • 422 — BOOKING_INVALID_SETTLEMENT_MODE | BOOKING_VALUE_EXCEEDED
  • 429 — GUEST_BOOKING_VELOCITY | RATE_LIMIT_EXCEEDED

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-earnings/api/v1/earnings​

GET /api-earnings/api/v1/earnings
Get host earnings summary.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-ical-feed​

GET /api-ical-feed
Download iCal feed.

Akses: Publik; tidak menggunakan API key.

Parameter

NamaLokasiWajibTipe
space_idqueryYastring (uuid)
tokenqueryYastring (uuid)

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — text/calendar
  • 401 — Invalid token

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

PATCH /api-listing-update/api/v1/spaces/{space_id}​

PATCH /api-listing-update/api/v1/spaces/{space_id}
Update listing fields.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Field request body

  • space_id — string
  • title — string
  • price — number
  • is_active — boolean

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-listings/api/v1/spaces​

GET /api-listings/api/v1/spaces
List all host spaces.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success
  • 401 — Unauthorized

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-listings/api/v1/spaces/{space_id}​

GET /api-listings/api/v1/spaces/{space_id}
Get space detail.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
space_idpathYastring (uuid)

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success
  • 404 — Not found

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-openapi​

GET /api-openapi
Get OpenAPI spec JSON.

Akses: Publik; tidak menggunakan API key.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-settlement-report/api/v1/settlement/report​

GET /api-settlement-report/api/v1/settlement/report
Get host settlement report for API bookings.

Akses: Memerlukan API key pada header Authorization.

Parameter

NamaLokasiWajibTipe
monthqueryYastring

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

GET /api-webhooks/api/v1/webhooks​

GET /api-webhooks/api/v1/webhooks
List webhooks.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

POST /api-webhooks/api/v1/webhooks​

POST /api-webhooks/api/v1/webhooks
Create webhook subscription.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Field request body

  • url — string
  • events — array
  • description — string

Gunakan nilai dari lingkungan integrasi yang diizinkan. Jangan menyalin data customer atau credential ke contoh publik.

Respons

  • 201 — Created

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

DELETE /api-webhooks/api/v1/webhooks/{id}​

DELETE /api-webhooks/api/v1/webhooks/{id}
Delete webhook.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

PATCH /api-webhooks/api/v1/webhooks/{id}​

PATCH /api-webhooks/api/v1/webhooks/{id}
Update webhook.

Akses: Memerlukan API key pada header Authorization.

Parameter: tidak ada parameter eksplisit.

Request body: tidak ada body JSON yang didokumentasikan.

Respons

  • 200 — Success

Untuk error non-2xx, simpan request ID dan kode error yang aman. Jangan log header Authorization atau payload sensitif.

Perhatian

Dokumentasi ini tidak memuat endpoint admin, operator-only maintenance commands, reconciliation command, replay, transfer, refund mutation, atau credential provider.

Terakhir diverifikasi: 2026-07-24