{"openapi":"3.0.1","info":{"description":"De Makelaar API biedt toegang tot makelaars- en kantoorgegevens binnen Realworks. De API is read-only en bevat onder andere vestigingsgegevens, contactgegevens, adresgegevens, openingstijden en social media-informatie.\n\n#### Zo gebruik je deze API\n* Haal de beschikbare makelaars en kantoren op met `GET /makelaars/v1`.\n* Gebruik de optionele `afdelingscode` om gegevens van een specifieke vestiging op te halen.\n* Gebruik paginering om alle beschikbare resultaten op te halen.\n\n#### Bijzonderheden\n* De API is uitsluitend bedoeld voor het raadplegen van makelaars- en kantoorgegevens.\n* Bij meerdere vestigingen kan met `afdelingscode` worden gefilterd op een specifieke vestiging.\n* Alleen gegevens waarvoor de gebruikte API-token geautoriseerd is, worden teruggegeven.\n\n#### Laatste wijzigingen\n* Nog geen wijzigingen geregistreerd.","title":"Makelaar"},"externalDocs":{"description":"OpenAPI Specification","url":"/openapi-doc/v1/Makelaar"},"servers":[{"url":"https://api.realworks.nl"}],"security":[{"rwauth":[]}],"tags":[{"name":"Makelaar"}],"paths":{"/makelaars/v1":{"get":{"description":"Alleen toegang tot gekoppelde bedrijven","operationId":"zoekenMakelaars","parameters":[{"description":"Access Level: **BASIS**<br/><br/>Indien er sprake is van meerdere vestigingen, kan in het veld <b>Afdelingscode</b> op specifieke vestiging gefilterd worden. (veld leeg geeft alle beschikbare data van alle vestigingen)","in":"query","name":"afdelingscode","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiSearchResultsMakelaar"}}},"description":"Succes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"content":{},"description":"Te veel aanvragen"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoeken door makelaars","tags":["Makelaar"]}}},"components":{"schemas":{"Adresgegevens":{"type":"object","properties":{"bezoekadres":{"$ref":"#/components/schemas/AdresgegevensBezoekadres"}},"description":"MakelaarAdresgegevens"},"AdresgegevensBezoekadres":{"type":"object","properties":{"huisnummer":{"type":"string","description":"Huisnummer","nullable":true},"huisnummertoevoeging":{"type":"string","description":"Huisnummer toevoeging","nullable":true},"land":{"type":"string","description":"Land","nullable":true},"plaats":{"type":"string","description":"Plaats (nieuw)","nullable":true},"postcode":{"type":"string","description":"Postcode","nullable":true},"straat":{"type":"string","description":"Straatnaam","nullable":true},"straat2":{"type":"string","description":"Straatnaam2","nullable":true}},"description":"MakelaarAdresgegevensBezoek"},"ApiSearchResultsMakelaar":{"type":"object","properties":{"paginering":{"$ref":"#/components/schemas/PaginationInfo"},"resultaten":{"type":"array","items":{"$ref":"#/components/schemas/Makelaar"}}},"description":"Zoekresultaten"},"ErrorResponse":{"type":"object","properties":{"meldingen":{"type":"array","items":{"type":"string"}}},"description":"Foutmeldingen"},"Makelaar":{"type":"object","properties":{"adresgegevens":{"$ref":"#/components/schemas/Adresgegevens"},"afdelingscode":{"type":"string","description":"Vestiging (eigenaar van het object)"},"emailadres":{"type":"string","description":"E-mail","nullable":true},"faxnummer":{"type":"string","description":"Faxnummer","nullable":true},"kantoornaam":{"type":"string","description":"Kantoornaam","nullable":true},"logoUrl":{"type":"string","description":"BedrijfslogoUrl","nullable":true},"omschrijving":{"type":"string","description":"Omschrijving","nullable":true},"openingstijden":{"type":"string","description":"Openingstijden","nullable":true},"social":{"$ref":"#/components/schemas/Social"},"telefoonnummer":{"type":"string","description":"Telefoonnummer","nullable":true},"tijdstipLaatsteWijziging":{"type":"string","description":"Tijdstip van laatste wijziging. Dit geeft geen garantie dat er daadwerkelijk iets gewijzigd is, maar geeft slechts een mogelijke wijziging aan.","nullable":true,"example":"2007-12-03 10:15:30"},"website":{"type":"string","description":"Website","nullable":true}}},"PaginationInfo":{"type":"object","properties":{"totaalAantal":{"type":"integer","format":"int64"},"volgende":{"type":"string","format":"uri","nullable":true}},"description":"Pagineringsinformatie"},"Social":{"type":"object","properties":{"facebook":{"type":"string","description":"Facebook","nullable":true},"instagram":{"type":"string","description":"Instagram","nullable":true},"linkedIn":{"type":"string","description":"LinkedIn","nullable":true},"pinterest":{"type":"string","description":"Pinterest","nullable":true},"twitter":{"type":"string","description":"Twitter","nullable":true},"youTube":{"type":"string","description":"YouTube","nullable":true}},"description":"MakelaarSocial"}},"securitySchemes":{"rwauth":{"in":"header","name":"Authorization","type":"apiKey"}}}}