[{"data":1,"prerenderedAt":845},["ShallowReactive",2],{"navigation_docs_en":3,"-en-getting-started-authentication":179,"-en-getting-started-authentication-surround":840},[4,36,57,87,107,127,143,154,162],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":35},"Getting Started","i-lucide-rocket","/en/getting-started","en/1.getting-started",[10,15,20,25,30],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","/en/getting-started/introduction","en/1.getting-started/1.introduction","i-lucide-info",{"title":16,"path":17,"stem":18,"icon":19},"Agency Setup","/en/getting-started/agency-setup","en/1.getting-started/2.agency-setup","i-lucide-building-2",{"title":21,"path":22,"stem":23,"icon":24},"Authentication","/en/getting-started/authentication","en/1.getting-started/3.authentication","i-lucide-key",{"title":26,"path":27,"stem":28,"icon":29},"Quick Start","/en/getting-started/quick-start","en/1.getting-started/4.quick-start","i-lucide-zap",{"title":31,"path":32,"stem":33,"icon":34},"Postman Collection","/en/getting-started/postman","en/1.getting-started/5.postman","i-lucide-download",false,{"title":37,"icon":38,"path":39,"stem":40,"children":41,"page":35},"Concepts","i-lucide-lightbulb","/en/concepts","en/2.concepts",[42,47,52],{"title":43,"path":44,"stem":45,"icon":46},"External ID","/en/concepts/external-ids","en/2.concepts/1.external-ids","i-lucide-link",{"title":48,"path":49,"stem":50,"icon":51},"Upsert Pattern","/en/concepts/upsert-pattern","en/2.concepts/2.upsert-pattern","i-lucide-refresh-cw",{"title":53,"path":54,"stem":55,"icon":56},"Async Jobs","/en/concepts/async-jobs","en/2.concepts/3.async-jobs","i-lucide-clock",{"title":58,"icon":59,"path":60,"stem":61,"children":62,"page":35},"Listings","i-lucide-home","/en/listings","en/3.listings",[63,68,73,78,83],{"title":64,"path":65,"stem":66,"icon":67},"Listings Overview","/en/listings/overview","en/3.listings/1.overview","i-lucide-layout-list",{"title":69,"path":70,"stem":71,"icon":72},"Create and Update","/en/listings/create-update","en/3.listings/2.create-update","i-lucide-plus",{"title":74,"path":75,"stem":76,"icon":77},"Retrieve Listings","/en/listings/retrieve","en/3.listings/3.retrieve","i-lucide-search",{"title":79,"path":80,"stem":81,"icon":82},"Bulk Operations","/en/listings/bulk","en/3.listings/4.bulk","i-lucide-layers",{"title":84,"path":85,"stem":86,"icon":46},"External ID Linking","/en/listings/external-id-linking","en/3.listings/5.external-id-linking",{"title":88,"icon":89,"path":90,"stem":91,"children":92,"page":35},"Users","i-lucide-users","/en/users","en/4.users",[93,98,103],{"title":94,"path":95,"stem":96,"icon":97},"Users Overview","/en/users/overview","en/4.users/1.overview","i-lucide-user",{"title":99,"path":100,"stem":101,"icon":102},"Update Profile","/en/users/update","en/4.users/2.update","i-lucide-user-pen",{"title":104,"path":105,"stem":106,"icon":77},"Retrieve Users","/en/users/retrieve","en/4.users/3.retrieve",{"title":108,"icon":109,"path":110,"stem":111,"children":112,"page":35},"Media","i-lucide-image","/en/media","en/5.media",[113,117,122],{"title":114,"path":115,"stem":116,"icon":109},"Media Overview","/en/media/overview","en/5.media/1.overview",{"title":118,"path":119,"stem":120,"icon":121},"Upload Files","/en/media/upload","en/5.media/2.upload","i-lucide-upload",{"title":123,"path":124,"stem":125,"icon":126},"Manage Files","/en/media/manage","en/5.media/3.manage","i-lucide-folder",{"title":128,"icon":129,"path":130,"stem":131,"children":132,"page":35},"Reference","i-lucide-book-open","/en/reference","en/6.reference",[133,138],{"title":134,"path":135,"stem":136,"icon":137},"Field Schema","/en/reference/schema","en/6.reference/1.schema","i-lucide-file-json",{"title":139,"path":140,"stem":141,"icon":142},"Currencies and Rates","/en/reference/currencies","en/6.reference/2.currencies","i-lucide-wallet",{"title":144,"icon":145,"path":146,"stem":147,"children":148,"page":35},"Errors","i-lucide-alert-triangle","/en/errors","en/7.errors",[149],{"title":150,"path":151,"stem":152,"icon":153},"Error Handling","/en/errors/error-handling","en/7.errors/1.error-handling","i-lucide-shield-alert",{"title":155,"path":156,"stem":157,"children":158,"icon":161},"Changelog","/en/changelog","en/8.changelog/1.index",[159],{"title":155,"path":156,"stem":157,"icon":160},"i-lucide-scroll-text","i-lucide-history",{"title":163,"path":164,"stem":165,"children":166,"page":35},"Guides","/en/guides","en/9.guides",[167,171,175],{"title":168,"path":169,"stem":170,"icon":129},"Integration Guides","/en/guides/overview","en/9.guides/1.overview",{"title":172,"path":173,"stem":174,"icon":121},"Initial Sync","/en/guides/first-sync","en/9.guides/2.first-sync",{"title":176,"path":177,"stem":178,"icon":51},"Continuous Sync","/en/guides/continuous-sync","en/9.guides/3.continuous-sync",{"id":180,"title":21,"body":181,"description":833,"extension":834,"links":835,"meta":836,"navigation":837,"path":22,"seo":838,"stem":23,"__hash__":839},"docs_en/en/1.getting-started/3.authentication.md",{"type":182,"value":183,"toc":824},"minimark",[184,188,193,237,244,248,256,507,512,521,545,549,556,708,712,808,812,815,820],[185,186,187],"p",{},"All CRM API requests require authentication via API key. The key identifies your agency and determines which data you can access.",[189,190,192],"h2",{"id":191},"create-an-api-key","Create an API Key",[194,195,196,214,228,234],"ol",{},[197,198,199,200,207,208,213],"li",{},"Log in to ",[201,202,206],"a",{"href":203,"rel":204},"https://rentix.md",[205],"nofollow","rentix.md"," (or ",[201,209,212],{"href":210,"rel":211},"https://staging.rentix.md",[205],"staging.rentix.md"," for testing)",[197,215,216,217,221,222,221,225],{},"Open ",[218,219,220],"strong",{},"User Menu"," → ",[218,223,224],{},"[Agency Name]",[218,226,227],{},"API Keys",[197,229,230,231],{},"Click ",[218,232,233],{},"Create Key",[197,235,236],{},"Copy the key — it's shown only once",[238,239,240,243],"warning",{},[218,241,242],{},"Keep your key secure."," Anyone with the key can manage your agency's listings. Don't commit keys to git and don't share with third parties.",[189,245,247],{"id":246},"use-the-key-in-requests","Use the Key in Requests",[185,249,250,251,255],{},"Pass the key in the ",[252,253,254],"code",{},"Authorization"," header of every request.",[257,258,259,422,455],"code-group",{},[260,261,267],"pre",{"className":262,"code":263,"filename":264,"language":265,"meta":266,"style":266},"language-js shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const response = await fetch('https://crm.rentix.md/api/v1/agency', {\n  headers: {\n    'Authorization': 'ApiKey YOUR_API_KEY'\n  }\n});\n\nconst agency = await response.json();\nconsole.log(agency.name); // \"Your Agency\"\n","Node.js","js","",[252,268,269,312,324,345,351,363,370,396],{"__ignoreMap":266},[270,271,274,278,282,286,290,294,297,300,304,306,309],"span",{"class":272,"line":273},"line",1,[270,275,277],{"class":276},"spNyl","const",[270,279,281],{"class":280},"sTEyZ"," response ",[270,283,285],{"class":284},"sMK4o","=",[270,287,289],{"class":288},"s7zQu"," await",[270,291,293],{"class":292},"s2Zo4"," fetch",[270,295,296],{"class":280},"(",[270,298,299],{"class":284},"'",[270,301,303],{"class":302},"sfazB","https://crm.rentix.md/api/v1/agency",[270,305,299],{"class":284},[270,307,308],{"class":284},",",[270,310,311],{"class":284}," {\n",[270,313,315,319,322],{"class":272,"line":314},2,[270,316,318],{"class":317},"swJcz","  headers",[270,320,321],{"class":284},":",[270,323,311],{"class":284},[270,325,327,330,332,334,336,339,342],{"class":272,"line":326},3,[270,328,329],{"class":284},"    '",[270,331,254],{"class":317},[270,333,299],{"class":284},[270,335,321],{"class":284},[270,337,338],{"class":284}," '",[270,340,341],{"class":302},"ApiKey YOUR_API_KEY",[270,343,344],{"class":284},"'\n",[270,346,348],{"class":272,"line":347},4,[270,349,350],{"class":284},"  }\n",[270,352,354,357,360],{"class":272,"line":353},5,[270,355,356],{"class":284},"}",[270,358,359],{"class":280},")",[270,361,362],{"class":284},";\n",[270,364,366],{"class":272,"line":365},6,[270,367,369],{"emptyLinePlaceholder":368},true,"\n",[270,371,373,375,378,380,382,385,388,391,394],{"class":272,"line":372},7,[270,374,277],{"class":276},[270,376,377],{"class":280}," agency ",[270,379,285],{"class":284},[270,381,289],{"class":288},[270,383,384],{"class":280}," response",[270,386,387],{"class":284},".",[270,389,390],{"class":292},"json",[270,392,393],{"class":280},"()",[270,395,362],{"class":284},[270,397,399,402,404,407,410,412,415,418],{"class":272,"line":398},8,[270,400,401],{"class":280},"console",[270,403,387],{"class":284},[270,405,406],{"class":292},"log",[270,408,409],{"class":280},"(agency",[270,411,387],{"class":284},[270,413,414],{"class":280},"name)",[270,416,417],{"class":284},";",[270,419,421],{"class":420},"sHwdD"," // \"Your Agency\"\n",[260,423,428],{"className":424,"code":425,"filename":426,"language":427,"meta":266,"style":266},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https://crm.rentix.md/api/v1/agency \\\n  -H \"Authorization: ApiKey YOUR_API_KEY\"\n","curl","bash",[252,429,430,441],{"__ignoreMap":266},[270,431,432,435,438],{"class":272,"line":273},[270,433,426],{"class":434},"sBMFI",[270,436,437],{"class":302}," https://crm.rentix.md/api/v1/agency",[270,439,440],{"class":280}," \\\n",[270,442,443,446,449,452],{"class":272,"line":314},[270,444,445],{"class":302},"  -H",[270,447,448],{"class":284}," \"",[270,450,451],{"class":302},"Authorization: ApiKey YOUR_API_KEY",[270,453,454],{"class":284},"\"\n",[260,456,460],{"className":457,"code":458,"filename":459,"language":459,"meta":266,"style":266},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","$ch = curl_init('https://crm.rentix.md/api/v1/agency');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n  'Authorization: ApiKey YOUR_API_KEY'\n]);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\n$agency = json_decode($response, true);\necho $agency['name']; // \"Your Agency\"\n","php",[252,461,462,467,472,477,482,487,491,496,501],{"__ignoreMap":266},[270,463,464],{"class":272,"line":273},[270,465,466],{},"$ch = curl_init('https://crm.rentix.md/api/v1/agency');\n",[270,468,469],{"class":272,"line":314},[270,470,471],{},"curl_setopt($ch, CURLOPT_HTTPHEADER, [\n",[270,473,474],{"class":272,"line":326},[270,475,476],{},"  'Authorization: ApiKey YOUR_API_KEY'\n",[270,478,479],{"class":272,"line":347},[270,480,481],{},"]);\n",[270,483,484],{"class":272,"line":353},[270,485,486],{},"curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n",[270,488,489],{"class":272,"line":365},[270,490,369],{"emptyLinePlaceholder":368},[270,492,493],{"class":272,"line":372},[270,494,495],{},"$response = curl_exec($ch);\n",[270,497,498],{"class":272,"line":398},[270,499,500],{},"$agency = json_decode($response, true);\n",[270,502,504],{"class":272,"line":503},9,[270,505,506],{},"echo $agency['name']; // \"Your Agency\"\n",[508,509,511],"h3",{"id":510},"alternative-header","Alternative Header",[185,513,514,515,517,518,321],{},"Instead of ",[252,516,254],{},", you can use ",[252,519,520],{},"X-API-Key",[260,522,524],{"className":424,"code":523,"language":427,"meta":266,"style":266},"curl https://crm.rentix.md/api/v1/agency \\\n  -H \"X-API-Key: YOUR_API_KEY\"\n",[252,525,526,534],{"__ignoreMap":266},[270,527,528,530,532],{"class":272,"line":273},[270,529,426],{"class":434},[270,531,437],{"class":302},[270,533,440],{"class":280},[270,535,536,538,540,543],{"class":272,"line":314},[270,537,445],{"class":302},[270,539,448],{"class":284},[270,541,542],{"class":302},"X-API-Key: YOUR_API_KEY",[270,544,454],{"class":284},[189,546,548],{"id":547},"verify-connection","Verify Connection",[185,550,551,552,555],{},"A request to ",[252,553,554],{},"/agency"," is a simple way to confirm your key works.",[260,557,561],{"className":558,"code":559,"filename":560,"language":390,"meta":266,"style":266},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"id\": 1,\n  \"name\": \"Your Agency\",\n  \"status\": \"active\",\n  \"isCrmEnabled\": true,\n  \"limits\": {\n    \"monthlyListings\": { \"used\": 5, \"limit\": 1000 }\n  }\n}\n","Successful Response",[252,562,563,568,588,608,628,642,655,699,703],{"__ignoreMap":266},[270,564,565],{"class":272,"line":273},[270,566,567],{"class":284},"{\n",[270,569,570,573,576,579,581,585],{"class":272,"line":314},[270,571,572],{"class":284},"  \"",[270,574,575],{"class":276},"id",[270,577,578],{"class":284},"\"",[270,580,321],{"class":284},[270,582,584],{"class":583},"sbssI"," 1",[270,586,587],{"class":284},",\n",[270,589,590,592,595,597,599,601,604,606],{"class":272,"line":326},[270,591,572],{"class":284},[270,593,594],{"class":276},"name",[270,596,578],{"class":284},[270,598,321],{"class":284},[270,600,448],{"class":284},[270,602,603],{"class":302},"Your Agency",[270,605,578],{"class":284},[270,607,587],{"class":284},[270,609,610,612,615,617,619,621,624,626],{"class":272,"line":347},[270,611,572],{"class":284},[270,613,614],{"class":276},"status",[270,616,578],{"class":284},[270,618,321],{"class":284},[270,620,448],{"class":284},[270,622,623],{"class":302},"active",[270,625,578],{"class":284},[270,627,587],{"class":284},[270,629,630,632,635,637,639],{"class":272,"line":353},[270,631,572],{"class":284},[270,633,634],{"class":276},"isCrmEnabled",[270,636,578],{"class":284},[270,638,321],{"class":284},[270,640,641],{"class":284}," true,\n",[270,643,644,646,649,651,653],{"class":272,"line":365},[270,645,572],{"class":284},[270,647,648],{"class":276},"limits",[270,650,578],{"class":284},[270,652,321],{"class":284},[270,654,311],{"class":284},[270,656,657,660,663,665,667,670,672,675,677,679,682,684,686,689,691,693,696],{"class":272,"line":372},[270,658,659],{"class":284},"    \"",[270,661,662],{"class":434},"monthlyListings",[270,664,578],{"class":284},[270,666,321],{"class":284},[270,668,669],{"class":284}," {",[270,671,448],{"class":284},[270,673,674],{"class":583},"used",[270,676,578],{"class":284},[270,678,321],{"class":284},[270,680,681],{"class":583}," 5",[270,683,308],{"class":284},[270,685,448],{"class":284},[270,687,688],{"class":583},"limit",[270,690,578],{"class":284},[270,692,321],{"class":284},[270,694,695],{"class":583}," 1000",[270,697,698],{"class":284}," }\n",[270,700,701],{"class":272,"line":398},[270,702,350],{"class":284},[270,704,705],{"class":272,"line":503},[270,706,707],{"class":284},"}\n",[189,709,711],{"id":710},"authentication-errors","Authentication Errors",[713,714,715,731],"table",{},[716,717,718],"thead",{},[719,720,721,725,728],"tr",{},[722,723,724],"th",{},"Code",[722,726,727],{},"Error",[722,729,730],{},"Solution",[732,733,734,754,771,783,796],"tbody",{},[719,735,736,740,745],{},[737,738,739],"td",{},"400",[737,741,742],{},[252,743,744],{},"Multiple authentication methods provided",[737,746,747,748,750,751,753],{},"Use either ",[252,749,254],{}," or ",[252,752,520],{},", not both",[719,755,756,759,764],{},[737,757,758],{},"401",[737,760,761],{},[252,762,763],{},"API key is required",[737,765,766,767,770],{},"Add ",[252,768,769],{},"Authorization: ApiKey YOUR_KEY"," header",[719,772,773,775,780],{},[737,774,758],{},[737,776,777],{},[252,778,779],{},"Invalid API key",[737,781,782],{},"Check that the API key is correct and has not been revoked",[719,784,785,788,793],{},[737,786,787],{},"403",[737,789,790],{},[252,791,792],{},"Agency is suspended",[737,794,795],{},"Contact support — your agency account is suspended",[719,797,798,800,805],{},[737,799,787],{},[737,801,802],{},[252,803,804],{},"CRM is not enabled for this agency",[737,806,807],{},"Contact support to enable CRM access",[189,809,811],{"id":810},"next-step","Next Step",[185,813,814],{},"Key is ready — create your first listing.",[185,816,817],{},[201,818,819],{"href":27},"Quick Start →",[821,822,823],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":266,"searchDepth":314,"depth":314,"links":825},[826,827,830,831,832],{"id":191,"depth":314,"text":192},{"id":246,"depth":314,"text":247,"children":828},[829],{"id":510,"depth":326,"text":511},{"id":547,"depth":314,"text":548},{"id":710,"depth":314,"text":711},{"id":810,"depth":314,"text":811},"How to create an API key and use it for API access","md",null,{},{"icon":24},{"title":21,"description":833},"eJhj5uu-BirpFsRRjJNN2tSXjUFIcO1XwsFTUavw6d8",[841,843],{"title":16,"path":17,"stem":18,"description":842,"icon":19,"children":-1},"How to register your agency and get CRM API access",{"title":26,"path":27,"stem":28,"description":844,"icon":29,"children":-1},"Publish your first listing in a single request",1773784454413]