[{"data":1,"prerenderedAt":187},["ShallowReactive",2],{"page:\u002F":3},{"id":4,"title":5,"body":6,"description":177,"extension":178,"meta":179,"navigation":180,"operation":181,"path":182,"rawbody":183,"seo":184,"stem":185,"__hash__":186},"docs\u002Findex.md","Vestta API",{"type":7,"value":8,"toc":168},"minimark",[9,13,16,21,49,53,73,77,95,99],[10,11,12],"p",{},"Use the Vestta API to read the public property catalogue of a Vestta workspace, work with its leads and connect websites, landing pages and external products to it. It is a JSON API over HTTPS, authenticated with API keys that carry explicit scopes.",[14,15],"home-actions",{},[17,18,20],"h2",{"id":19},"get-started","Get started",[22,23,24,33,41],"link-cards",{},[25,26,30],"link-card",{"icon":27,"title":28,"to":29},"rocket","Quickstart","\u002Fquickstart",[10,31,32],{},"Make your first authenticated API request.",[25,34,38],{"icon":35,"title":36,"to":37},"key","Authentication","\u002Fauthentication",[10,39,40],{},"Understand API keys and scopes.",[25,42,46],{"icon":43,"title":44,"to":45},"braces","API Reference","\u002Freference",[10,47,48],{},"Explore the available resources and schemas.",[17,50,52],{"id":51},"core-resources","Core resources",[54,55,56,65],"link-list",{},[57,58,62],"link-row",{"icon":59,"title":60,"to":61},"building","Properties","\u002Fproperties",[10,63,64],{},"Read property data from Vestta: the public catalogue, with filters, prices, images and locations.",[57,66,70],{"icon":67,"title":68,"to":69},"users","Leads","\u002Fleads",[10,71,72],{},"Read and send lead information, from simple rental forms to detailed contact requests.",[17,74,76],{"id":75},"guides","Guides",[54,78,79,87],{},[57,80,84],{"icon":81,"title":82,"to":83},"alert","Errors","\u002Ferrors",[10,85,86],{},"The error format, every error the API returns and how to handle it.",[57,88,92],{"icon":89,"title":90,"to":91},"lifebuoy","Troubleshooting","\u002Ftroubleshooting",[10,93,94],{},"Fixes for the problems integrations run into most often.",[17,96,98],{"id":97},"at-a-glance","At a glance",[100,101,102,113],"table",{},[103,104,105],"thead",{},[106,107,108,111],"tr",{},[109,110],"th",{},[109,112],{},[114,115,116,128,138,146,154],"tbody",{},[106,117,118,122],{},[119,120,121],"td",{},"Base URL",[119,123,124],{},[125,126,127],"code",{},"https:\u002F\u002Fapi.vestta.app\u002Fv1\u002Fext",[106,129,130,132],{},[119,131,36],{},[119,133,134,137],{},[125,135,136],{},"X-Api-Key"," header with a key created in Vestta",[106,139,140,143],{},[119,141,142],{},"Format",[119,144,145],{},"JSON over HTTPS",[106,147,148,151],{},[119,149,150],{},"Availability",[119,152,153],{},"Workspaces on the Premium and Enterprise plans",[106,155,156,159],{},[119,157,158],{},"Schema",[119,160,161,167],{},[162,163,165],"a",{"href":164},"\u002Fopenapi.json",[125,166,164],{}," (OpenAPI 3.1)",{"title":169,"searchDepth":170,"depth":170,"links":171},"",3,[172,174,175,176],{"id":19,"depth":173,"text":20},2,{"id":51,"depth":173,"text":52},{"id":75,"depth":173,"text":76},{"id":97,"depth":173,"text":98},"Build integrations on top of your real estate data.","md",{},true,null,"\u002F","---\ntitle: Vestta API\ndescription: Build integrations on top of your real estate data.\n---\n\nUse the Vestta API to read the public property catalogue of a Vestta workspace, work with its leads and connect websites, landing pages and external products to it. It is a JSON API over HTTPS, authenticated with API keys that carry explicit scopes.\n\n:home-actions\n\n## Get started\n\n::link-cards\n:::link-card{to=\"\u002Fquickstart\" icon=\"rocket\" title=\"Quickstart\"}\nMake your first authenticated API request.\n:::\n\n:::link-card{to=\"\u002Fauthentication\" icon=\"key\" title=\"Authentication\"}\nUnderstand API keys and scopes.\n:::\n\n:::link-card{to=\"\u002Freference\" icon=\"braces\" title=\"API Reference\"}\nExplore the available resources and schemas.\n:::\n::\n\n## Core resources\n\n::link-list\n:::link-row{to=\"\u002Fproperties\" icon=\"building\" title=\"Properties\"}\nRead property data from Vestta: the public catalogue, with filters, prices, images and locations.\n:::\n\n:::link-row{to=\"\u002Fleads\" icon=\"users\" title=\"Leads\"}\nRead and send lead information, from simple rental forms to detailed contact requests.\n:::\n::\n\n## Guides\n\n::link-list\n:::link-row{to=\"\u002Ferrors\" icon=\"alert\" title=\"Errors\"}\nThe error format, every error the API returns and how to handle it.\n:::\n\n:::link-row{to=\"\u002Ftroubleshooting\" icon=\"lifebuoy\" title=\"Troubleshooting\"}\nFixes for the problems integrations run into most often.\n:::\n::\n\n## At a glance\n\n| | |\n| --- | --- |\n| Base URL | `https:\u002F\u002Fapi.vestta.app\u002Fv1\u002Fext` |\n| Authentication | `X-Api-Key` header with a key created in Vestta |\n| Format | JSON over HTTPS |\n| Availability | Workspaces on the Premium and Enterprise plans |\n| Schema | [`\u002Fopenapi.json`](\u002Fopenapi.json) (OpenAPI 3.1) |\n",{"title":5,"description":177},"index","j0neJQxAlVyxthQ8xRRIEdKYsXQ3ky0v0RtB9BsdVrY",1791110048049]