Skip to content
Documentation · Properly Platform API

Getting started

Properly Platform API

The Properly Platform API is a REST API for property management systems and partners to sync properties, bookings, checklists, and cleaning jobs with Properly, and to receive job lifecycle events over signed webhooks.

What the API does

The Properly Platform API is the integration surface for the Properly vacation rental operations platform. With it you can:

  • Mirror your property catalog into Properly, including pictures and access details.
  • Push bookings so turnovers are scheduled automatically.
  • Define photo checklists and receive per-task completion by taskId when a job finishes.
  • Send job requests to service providers, update them, cancel them, and chat on them.
  • Receive every lifecycle event (accepted, started, completed, problem reported, new message) as a signed webhook, or poll for them.

Get API access

API keys are issued in the Properly web app under Settings → API & AI assistants, to accounts on the Platform Pro and Real-Time Inspection plans. The key is shown once at creation; revocation is immediate from the same page.

For assisted onboarding, email api@getproperly.com.

Your first request:

curl 
curl https://platform.getproperly.com/v1/properties \
  -H "x-api-key: $PROPERLY_API_KEY"

At a glance

Base URL https://platform.getproperly.com
Protocol REST over HTTPS, JSON request and response
Authentication x-api-key header on every route except GET /v1/health
Errors RFC 7807 application/problem+json on every non-2xx
Idempotency Optional Idempotency-Key header on POST, PATCH and DELETE (not /v1/webhooks)
Rate limits 100 requests per rolling 2 s and 30,000 per day, per key
Webhooks HMAC-signed (Standard Webhooks); 90-day event retention
Request id Every response carries x-request-id (echoed if you send one)

Download the OpenAPI spec (YAML) to generate a client library or import the API into Postman, Insomnia, or another HTTP client. It is OpenAPI 3.1 and describes every endpoint on this site.

Documentation

Getting started

  • Quickstart — Key, first request, first webhook, first verified delivery.
  • Authentication — Where keys come from, how they are sent, and how revocation behaves.

API reference

  • Properties — Create, list, fetch, update, and delete properties.
  • Property pictures — Attach and remove pictures fetched from your own URLs.
  • Bookings — Create, list, and read bookings; change dates, cancel, delete.
  • Checklists — Task groups, tasks, and the taskId mapping used by completed-job webhooks.
  • Reminders — Reminders that surface as todos and pre-fill job requests.
  • Job requests — Create, list, and manage jobs, one-off tasks, payment status, and the job chat.

Webhooks & events

  • Webhooks — Subscriptions, the delivery contract, signature verification, rotation, and the delivery log.
  • Event catalog — All 28 events with payload shapes.
  • Events (polling) — The pull-based twin of webhooks for backfill or no-inbound-HTTPS setups.

AI assistants

  • MCP — The read-only MCP server hosts connect to Claude or ChatGPT, and its 6 tools.

Conventions

  • Errors — The problem+json model and every problem type.
  • Idempotency — Safe retries with Idempotency-Key.
  • Rate limits — Both windows, the headers, and handling 429.

Migration

Type to search the Platform API docs.