VaultRE API
14 endpoints for VaultRE, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/vaultre
- Connects with
- Your own MRI Vault (VaultRE) user. What the agent can see and change follows your user profile permissions.
- Integration page
- VaultRE
Read (7)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Holding Area enquiries with source, message, property asked about and the duplicate Vault suggests. |
| GET | Find people, companies and suppliers by name, contact ID, company, phone, email or category. |
| GET | One contact card: details, categories, requirements, linked properties and upcoming events. |
| GET | Notes on a contact card, newest first, with type, text, reminder and who wrote them. |
| GET | Properties by class, type, status, agent, location or address, with agents and last update. |
| GET | One property card: status, agents, owners, method of sale, price, open homes and offers. |
| GET | Events, appraisals and scheduled viewings in a user's calendar between two dates. |
Write (7)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| POST | Add a Holding Area enquiry to the database as a contact, with its note and optional buyer requirement. |
| POST | Mark a Holding Area enquiry as ignored, for spam or leads you do not want in the database. |
| POST | Add a person, company, supplier or solicitor, with a source of enquiry, categories and a first note. |
| POST | Add a note to a contact or a property, with an optional reminder. |
| POST | Add an appraisal for an owner and a property, assigned to an appraiser with a date in their calendar. |
| POST | Book a scheduled viewing for a property in an agent's calendar, with the attendee attached. |
| POST | Add an open home to a property with date, times, a primary agent and optional secondary agents. |