The Properly Platform API lets your developer connect Properly to your other systems. Use it when you want information to move between tools automatically, or when you want another system to create and track work in Properly.
If you want to ask questions about your Properly data in everyday language rather than build an integration, see Connect an AI assistant to Properly instead. That needs no code.
Who it is for
The API is built for developers and integration partners. You will need someone who can write and host code. If you do not have a developer, one of our existing PMS integrations may already cover what you need.
Plan availability
API access is included with Platform Pro and Real-Time Inspection. If you are not sure which plan your account is on, contact us and we will check for you.
How to get an API key
In Properly, go to Settings, then API & AI assistants.
Create an API key.
Give the key to your developer, who should store it on your server and never in a browser, a shared document or a chat message.
If you cannot see that setting, or you would like help, email api@getproperly.com.
What you can build
Create and manage job requests. A custom workflow can raise a cleaning or maintenance job with a schedule, a checklist and your chosen service providers, then update or cancel it when plans change. Creating a request is not the same as a service provider accepting it.
React to events as they happen. Properly can send event notifications, called webhooks, when a job is accepted, started or completed, or when a problem is reported. Your integration can use these to update a dashboard, open a maintenance ticket or alert the right person.
Build checklists from a template. When new properties join your portfolio, an integration can create property specific checklists from an approved template rather than rebuilding each one by hand.
Report on completed work. Send job completions, checklist results and reported problems to your own reporting tool so you can track quality over time or prepare owner updates.
Each of these needs integration work on your side. Confirm your own systems and requirements with your developer before committing to a workflow.
Developer documentation
Your developer can start with the API quickstart. Reference material for job requests, checklists and the webhook event catalog is published alongside it.