# Vestta API > REST API to read the public property catalogue of a Vestta real estate workspace, read its leads and send new leads into it. Authenticated with API keys (`X-Api-Key`) and scopes. Base URL: https://api.vestta.io/v1 OpenAPI: https://api-docs.vestta.io/openapi.json Full documentation as one file: https://api-docs.vestta.io/llms-full.txt ## Getting started - [Vestta API](https://api-docs.vestta.io): Build integrations on top of your real estate data. - [Quickstart](https://api-docs.vestta.io/quickstart): Create an API key and make your first authenticated request to the Vestta API. - [Authentication](https://api-docs.vestta.io/authentication): Authenticate every request with an API key, and grant each key only the scopes it needs. - [API keys](https://api-docs.vestta.io/api-keys): Create, store, rotate and revoke the API keys that give your integrations access to Vestta. ## Concepts - [Requests & responses](https://api-docs.vestta.io/requests): Base URL, formats and conventions shared by every endpoint of the Vestta API. - [Pagination](https://api-docs.vestta.io/pagination): Page through properties and leads with limit and offset. ## Resources - [Properties](https://api-docs.vestta.io/properties): Create, edit and publish properties, and read their protected public catalogue. - [List properties](https://api-docs.vestta.io/properties/list): Return the public property catalogue, filtered, sorted and paginated. - [Retrieve a property](https://api-docs.vestta.io/properties/retrieve): Return one property of the public catalogue by its ID. - [Create a property](https://api-docs.vestta.io/properties/create): Creates a private CRM property. Publication is a separate operation. - [Update a property](https://api-docs.vestta.io/properties/update): Update a property without exposing its private CRM record. - [Prepare image uploads](https://api-docs.vestta.io/properties/uploads): Get temporary PUT URLs for original image uploads. - [Complete image uploads](https://api-docs.vestta.io/properties/complete-uploads): Verify uploaded originals and attach them to the property. - [Publish or unpublish](https://api-docs.vestta.io/properties/publication): Set desired visibility and generate protected public images. - [Retrieve publication status](https://api-docs.vestta.io/properties/publication-status): Check requested visibility, processing state and marked images. - [Leads](https://api-docs.vestta.io/leads): Read the leads of a Vestta workspace and send new leads from your forms and services. - [List leads](https://api-docs.vestta.io/leads/list): Return the leads of the workspace, newest first. - [Retrieve a contact](https://api-docs.vestta.io/leads/retrieve): Retrieve a contact belonging to your workspace. - [Create a contact](https://api-docs.vestta.io/leads/create): Create a private CRM contact without initiating outreach. - [Update a contact](https://api-docs.vestta.io/leads/update): Update only supplied contact fields. - [Ingest a rental lead](https://api-docs.vestta.io/leads/ingest): Create a rental-seeking lead from the compact payload used by rental landing forms. - [Create an inquiry](https://api-docs.vestta.io/leads/inquiries): Create a lead with contact details and structured search preferences, and get its ID back. - [Retrieve key context](https://api-docs.vestta.io/me): Return the workspace and scopes of the API key used for the request. ## Guides - [Errors](https://api-docs.vestta.io/errors): Standard problem responses, request IDs and safe retry rules. - [Troubleshooting](https://api-docs.vestta.io/troubleshooting): Fixes for the problems integrations with the Vestta API run into most often. - [Publishing properties](https://api-docs.vestta.io/publishing): Create a listing, upload original photos and publish marked images safely. - [Documentation for AI agents](https://api-docs.vestta.io/agents): Read any documentation page as Markdown or plain text, or download the complete API reference. ## Updates - [Changelog](https://api-docs.vestta.io/changelog): Changes to the Vestta API and its documentation. ## API reference - [API reference](https://api-docs.vestta.io/reference): Every endpoint of the Vestta API, generated from its OpenAPI schema. ## Markdown representations Request a page with Accept: text/markdown or Accept: text/plain, or use its .md or .txt URL. HTML remains the default. Full public text: https://api-docs.vestta.io/llms-full.txt - [Vestta API](https://api-docs.vestta.io/index.md) - [Documentation for AI agents](https://api-docs.vestta.io/agents.md) - [API keys](https://api-docs.vestta.io/api-keys.md) - [Authentication](https://api-docs.vestta.io/authentication.md) - [Changelog](https://api-docs.vestta.io/changelog.md) - [Errors](https://api-docs.vestta.io/errors.md) - [Leads](https://api-docs.vestta.io/leads.md) - [Create a contact](https://api-docs.vestta.io/leads/create.md) - [Ingest a rental lead](https://api-docs.vestta.io/leads/ingest.md) - [Create an inquiry](https://api-docs.vestta.io/leads/inquiries.md) - [List leads](https://api-docs.vestta.io/leads/list.md) - [Retrieve a contact](https://api-docs.vestta.io/leads/retrieve.md) - [Update a contact](https://api-docs.vestta.io/leads/update.md) - [Retrieve key context](https://api-docs.vestta.io/me.md) - [Pagination](https://api-docs.vestta.io/pagination.md) - [Properties](https://api-docs.vestta.io/properties.md) - [Complete image uploads](https://api-docs.vestta.io/properties/complete-uploads.md) - [Create a property](https://api-docs.vestta.io/properties/create.md) - [List properties](https://api-docs.vestta.io/properties/list.md) - [Publish or unpublish](https://api-docs.vestta.io/properties/publication.md) - [Retrieve publication status](https://api-docs.vestta.io/properties/publication-status.md) - [Retrieve a property](https://api-docs.vestta.io/properties/retrieve.md) - [Update a property](https://api-docs.vestta.io/properties/update.md) - [Prepare image uploads](https://api-docs.vestta.io/properties/uploads.md) - [Publishing properties](https://api-docs.vestta.io/publishing.md) - [Quickstart](https://api-docs.vestta.io/quickstart.md) - [API reference](https://api-docs.vestta.io/reference.md) - [Requests & responses](https://api-docs.vestta.io/requests.md) - [Swagger UI](https://api-docs.vestta.io/swagger.md) - [Troubleshooting](https://api-docs.vestta.io/troubleshooting.md)