De vFound API en webhooks
Koppel de vFound-suite aan de systemen die je al gebruikt: accommodatiesystemen, servicedesks, HR- en studentensystemen, scanners in de postkamer, datawarehouses of je eigen apps. Lees en wijzig dossiers in elk product, houd je personenlijst gesynchroniseerd, ontvang binnen enkele seconden een ondertekende webhook wanneer er iets gebeurt en laat AI-assistenten helpen aan de balie.
Wil je hulp bij het instellen? Bekijk de vFound-integratiegidsen voor Cloudbeds, OfficeRnD Flex, Microsoft Entra, Slack, Microsoft Teams, Google Chat, agenda's, Zapier en MCP-clients.
Authenticatie
Elke locatie heeft de API. Een eigenaar of manager maakt tot 10 sleutels aan onder Instellingen, Voor ontwikkelaars en kiest wat elke sleutel mag doen. De volledige sleutel wordt één keer getoond. Stuur hem mee als Bearer-token:
curl https://vfound.io/api/v1/items \
-H "Authorization: Bearer vf_live_xxxxxxxxxx_…"
| Scope | Staat toe | Endpoints |
|---|---|---|
items:read | Gevonden voorwerpen, categorieën en verplaatsingen tussen locaties lezen | GET /items, /items/{id}, /categories, /item-transfers |
items:write | Gevonden voorwerpen toevoegen en bijwerken, en ze verzenden naar of ontvangen van andere locaties | POST /items, PATCH /items/{id}, POST /item-transfers en de bijbehorende annuleer- en ontvangstacties |
claims:write | Menselijke beoordelingen van eigendom, beslissingen, goedkeuring voor vrijgave en ophalen vastleggen | POST /claims/{id}/verification, /claims/{id}/decision, /claims/{id}/release-approval, /claims/{id}/handover |
lost_reports:write | Meldingen van gasten aanmaken voor een contactcenter | POST /lost-reports |
claims:read | Claims lezen, met de contactgegevens van de aanvrager | GET /claims, /claims/{id} |
lost_reports:read | Verliesmeldingen van gasten lezen | GET /lost-reports |
analytics:read | De samenvatting van de analyses lezen | GET /analytics |
parcels:read | Pakketten lezen, met naam en e-mailadres van elke ontvanger | GET /parcels, /parcels/{id} |
parcels:write | Registreren, overhandigen, retourneren en herinneren | POST /parcels en de bijbehorende acties |
checkroom:read | Tickets, posten, evenementen, de ophaalrij en rapporten lezen | GET onder /checkroom |
checkroom:write | Inchecken, teruggeven, klaarzetten en posten of evenementen beheren | POST en PUT onder /checkroom |
loans:read | Apparatuur lezen en wie het heeft | GET /loans, /loans/items en van elk één |
loans:write | Apparatuur toevoegen, uitgeven, verlengen en innemen | POST en PATCH onder /loans |
visitors:read | Bezoeken lezen | GET /visitors, /visitors/{id} |
visitors:write | Uitnodigen, aan- en afmelden, annuleren, een pas sturen | POST /visitors en de bijbehorende acties |
visitors:screening | Bevestigen dat de screeningstreffer van een bezoeker is gecontroleerd: stuur screening_reviewed, of keur een bezoek goed dat door een treffer wordt tegengehouden. Standaard uit; wat de sleutel doet wordt vastgelegd als handeling van de sleutel, met de naam ervan | POST /visitors, /visitors/{id}/sign-in, /visitors/{id}/approve |
people:read | De personenlijst lezen | GET /people, /people/{id} |
people:write | Personen toevoegen, bijwerken, synchroniseren en verwijderen | POST, PATCH en DELETE onder /people |
stays:read | Privécontext van hotelverblijven lezen, met de correctiegeschiedenis | GET /stays, /stays/{stay} |
stays:write | Verblijfscontext van een hotelsysteem idempotent toevoegen of bijwerken | POST /stays |
school:read | Te late aankomsten en vroeg vertrek van leerlingen lezen vanuit het schoolsecretariaat | GET /school/movements |
school:write | Leerlingen toevoegen of bijwerken vanuit het schoolinformatiesysteem | PUT /school/pupils |
queue:read | Wachtrijen, tickets, gereserveerde tijden, berichten, enquêtecijfers en het Queue-rapport lezen | GET onder /queue |
queue:write | Mensen aan een rij toevoegen, ze oproepen, hun tickets afronden, tijden reserveren en annuleren en berichten sturen naar mensen in de rij | POST onder /queue |
webhooks:manage | De eigen webhookadressen van de sleutel aan- en afmelden, voor gebeurtenissen waarvan de sleutel de gegevens kan lezen | GET, POST en DELETE /webhooks |
Voorwerpen, claims, verliesmeldingen en analyses vragen om vFound Lost & Found; pakketten vragen om vFound Parcels; tickets vragen om vFound Checkroom; apparatuur vraagt om vFound Equipment; bezoeken vragen om vFound Visitors; de personenlijst vraagt om Parcels, Visitors of Equipment; hotelverblijven vragen om Lost & Found of Parcels; het schoolsecretariaat vraagt om Visitors met het schoolsecretariaat ingeschakeld (het antwoordt 404 zolang het uit staat); wachtrijen en tickets vragen om vFound Queue. Een product dat niet is geopend voor de locatie antwoordt 403.
Een sleutel handelt als de persoon die hem heeft aangemaakt en stopt met werken als die persoon de locatie niet meer beheert, tenzij het verzoek een teamlid noemt in X-Acting-User (zie Handelen namens een teamlid). Wijzigingen met een sleutel volgen dezelfde regels, e-mails en auditlog als aan de balie, en elke auditregel noteert de sleutel die de wijziging maakte. Elke sleutel kan 120 verzoeken per minuut doen. Basisadres: https://vfound.io/api/v1. Lijsten geven 25 dossiers per pagina terug (tot 100 met per_page) en accepteren page; de meeste filteren ook op updated_since (ISO 8601) en search, zoals hieronder vermeld.
Testsleutels
Een sleutel die als testsleutel is gemaakt begint met vf_test_ en kan alleen queue:read en queue:write bevatten. Hij werkt op één gelabelde testrij, Test line (sandbox) (rij 1, balie 1), en nergens anders: dezelfde Queue-adressen als bij een echte sleutel voor rijen, tijdvakken, tickets, /queue/join, call next, call, served, no-show en remove antwoorden vanuit de testrij; elk ander adres antwoordt 403 met code: test_key. Een testsleutel leest of wijzigt nooit een echte rij of echt ticket en verstuurt geen e-mail, sms, browsermelding of webhook. Een testsleutel negeert Idempotency-Key: hetzelfde verzoek twee keer verstuurd wordt twee keer uitgevoerd. Antwoorden bevatten "sandbox": true en de header X-Vfound-Sandbox: 1. Een testrij bevat tot 100 tickets per sleutel, zonder e-mailadres, en ze worden verwijderd met de sleutel en na zeven dagen. Gebruik verzonnen namen.
Veilig opnieuw proberen
Stuur een Idempotency-Key-header mee (een willekeurige unieke waarde van maximaal 191 zichtbare tekens, zoals een UUID) bij een POST, PATCH of DELETE. Als de verbinding wegvalt en je binnen 24 uur hetzelfde verzoek opnieuw verstuurt met dezelfde sleutel, herhaalt vFound de wijziging niet: het geeft het eerste antwoord terug met de header Idempotent-Replayed: true. Dezelfde sleutel met een ander verzoek wordt geweigerd (422, idempotency_key_reused); een sleutel waarvan het eerste verzoek nog loopt antwoordt 409 (idempotency_in_progress). Nadat persoonsgegevens van vinders of aanvragers zijn gewist, geven opgeslagen antwoorden voor die locatie in plaats daarvan 410 terug, zonder de gewiste gegevens; ververs het dossier in plaats van de oude schrijfactie met een nieuwe sleutel opnieuw te proberen. Serverfouten worden niet bewaard, dus opnieuw proberen na zo'n fout voert het verzoek opnieuw uit. Een antwoord dat iets bevat dat maar één keer wordt getoond, zoals het ondertekeningsgeheim van POST /webhooks of een koppelcode voor een kiosk, wordt ook nooit opgeslagen: een nieuwe poging voert het verzoek opnieuw uit, dus controleer GET /webhooks voordat je hetzelfde adres twee keer aanmeldt.
Handelen namens een teamlid
Een app die je team aan de balie gebruikt, zoals een app voor een post of depot, kan aangeven namens welk teamlid hij handelt. Stuur X-Acting-User mee met het inlogadres van de persoon of hun gebruikers-id. Die persoon moet op dat moment een actief lid zijn van de locatie van de sleutel. Het verzoek wordt dan uitgevoerd als die persoon: de geschiedenis van het voorwerp en van de claim noemt die persoon in plaats van de maker van de sleutel, en het auditlog noemt die persoon, de sleutel en de manager die de sleutel heeft aangemaakt. Ze kunnen alleen doen wat zowel de scopes van de sleutel als hun eigen rol op de locatie toestaan: een kijker kan alleen lezen, medewerkers kunnen ook voorwerpen, claims, verliesmeldingen, pakketten, checkroomtickets, apparatuur, bezoeken en hotelverblijven wijzigen, en eigenaren en managers kunnen elke scope gebruiken die de sleutel heeft. Een naam die geen actief lid van de locatie is, wordt geweigerd met 403 en acting_user_refused, met dezelfde melding of het adres nu bestaat of niet; een scope die de rol van de persoon niet toestaat, wordt geweigerd met 403 en acting_user_role. Veilig opnieuw proberen wordt per persoon bewaard, dus het opgeslagen antwoord van de ene persoon wordt nooit voor een ander afgespeeld. De header werkt alleen met locatiesleutels, niet met een assistent die via inloggen is gekoppeld en al handelt als de persoon die hem heeft gekoppeld. vFound controleert dat de genoemde persoon een actief lid is; het vraagt die persoon niet om in te loggen, dus noem alleen mensen vanuit een app waarin je team inlogt. Zonder de header werkt een sleutel precies zoals voorheen.
OpenAPI
De hele API, elke gebeurtenis en elk object staat beschreven in een OpenAPI 3.1-bestand: vfound.io/openapi/v1.json. Importeer het in Postman, Insomnia of je eigen codegenerator. Een test houdt het gelijk met de API, dus het noemt nooit een endpoint dat niet bestaat en mist er nooit een dat wel bestaat.
Kant-en-klare koppelingen met operationele systemen
Eigenaren en managers stellen deze alleen-lezen koppelingen met aanbieders in onder Instellingen, Koppelingen, Operationele systemen. Ze staan los van de openbare REST API: de klant maakt en beheert de inloggegevens bij de aanbieder, de koppeling moet een test doorstaan voordat hij wordt geactiveerd, herhaalde fouten pauzeren alleen die koppeling en handwerk blijft beschikbaar.
| Systeem | Wat vFound leest | vFound-onderdelen |
|---|---|---|
| Cloudbeds | Minimale reserverings- en kamercontext via een sleutel van de accommodatie die de klant zelf beheert en die beperkt is tot read:reservation. Onderdeel van vFound Enterprise. | Privéverblijven voor Lost & Found en Parcels |
| OfficeRnD Flex | Lid-id, naam, e-mailadres en actieve status via flex.community.members.read, met een optioneel locatiefilter. | De gedeelde personenlijst voor Parcels, Equipment en Visitors |
| Microsoft Entra ID | Gebruikers-id, weergavenaam, e-mailadres en actieve status via Microsoft Graph-deltaupdates en door een beheerder goedgekeurde User.Read.All. | De gedeelde personenlijst voor Parcels, Equipment en Visitors |
Dit zijn API-koppelingen die de klant zelf instelt, geen beweringen over certificering door een leverancier. Een koppeling testen, inschakelen en synchroniseren hoort bij vFound Enterprise. De Entra-koppeling is in het bijzonder geen app in de Microsoft Marketplace.
Voorwerpen
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/items | Voorwerpen, de laatst gewijzigde eerst. Filters: status, search (woorden in de titel, beschrijving, het merk, de kleur of de tags), updated_since (ISO 8601), page, per_page (tot 100). | items:read |
| GET/items/{id} | Eén voorwerp op basis van zijn id. | items:read |
| GET/categories | De categorienamen die een voorwerp kan gebruiken. | items:read |
| POST/items | Voeg een gevonden voorwerp toe. Het wordt gepubliceerd op je pagina voor gasten, start meldingen en matching, en verschijnt in je auditlog net als een voorwerp dat met de hand is toegevoegd. | items:write |
| PATCH/items/{id} | Wijzig details of status. | items:write |
| GET/item-transfers | Gevonden voorwerpen die deze locatie naar een andere locatie van dezelfde klantgroep heeft gestuurd of ervan ontvangt, met voorwerpen die onderweg zijn eerst. Toont ook de locaties waarnaar je kunt sturen (destinations) en de opslagbakken van deze locatie (bins). Filters: status (in_transit, received of cancelled), direction (incoming of outgoing). | items:read |
| POST/item-transfers | Stuur een voorwerp dat op zijn eigenaar wacht naar een andere locatie van de groep: item_id, destination_business_id en een optionele note. Alleen voor sleutels die een eigenaar of manager heeft gemaakt. Het voorwerp verdwijnt van de pagina voor gasten van de verzendende locatie (als die locatie haar gevonden voorwerpen toont) en kan niet meer wijzigen totdat het is aangekomen. Een voorwerp met een claim blijft waar het is. | items:write |
| POST/item-transfers/{id}/cancel | De verzendende locatie neemt het voorwerp terug voordat het is ontvangen. | items:write |
| POST/item-transfers/{id}/receive | De ontvangende locatie bevestigt dat het is aangekomen, met bin_id (verplicht als de locatie opslagbakken heeft) of location. Het voorwerp hoort dan bij deze locatie, met zijn foto's, geschiedenis en data, en wordt vergeleken met de verliesmeldingen van deze locatie net als een nieuw geregistreerd voorwerp. | items:write |
Hulpmiddelen voor de balie van Lost & Found en Checkroom
Nieuwe e-mailinstellingen staan standaard uit. Scantellingen en afwijkingen bij het sluiten dienen alleen ter controle. P90 gebruikt het 90e percentiel volgens de nearest-rank-methode van geldige tijdsintervallen; ontbrekende metingen geven null terug. De fysieke capaciteit in stuks waarschuwt, maar blokkeert het inchecken nooit. Zie de OpenAPI-beschrijving voor de velden van een verzoek. Sjablonen voor het instellen en instellingen vragen om een eigenaar of manager.
| Methode en pad | Wat het doet | Scope |
|---|---|---|
| GET /lost-found/context-schema | Lees versiebeheerde definities van privécontextvelden, zonder waarden van dossiers. Elk van de genoemde leesscopes is voldoende. | items:read of lost_reports:read |
| GET /lost-found/desk-settings | Lees de optionele instellingen van de balie. | lost_reports:read |
| PUT /lost-found/desk-settings | Vervang de instellingen van de balie; alleen eigenaar of manager. Nieuwe mailinstellingen staan standaard uit. | lost_reports:write |
| GET /checkroom/desk-settings | Lees de optionele instellingen van de balie. | checkroom:read |
| PUT /checkroom/desk-settings | Vervang de instellingen van de balie; alleen eigenaar of manager. Nieuwe mailinstellingen staan standaard uit. | checkroom:write |
| GET /lost-found/counts | Toon de laatste 30 telsessies met scans. | items:read |
| POST /lost-found/counts | Maak een momentopname van de identificatiegegevens van vastgehouden voorwerpen voor een telling die alleen rapporteert; er verandert niets aan de bewaring. | items:write |
| GET /lost-found/counts/{id} | Lees een telling met de cijfers voor ontbrekende, onverwachte en niet meer aanwezige voorwerpen. | items:read |
| POST /lost-found/counts/{id}/scan | Leg een scan van een QR-code of kort voorwerplabel vast; bekende voorwerpen die dubbel worden gescand tellen één keer. | items:write |
| POST /lost-found/counts/{id}/finish | Rond een telling af zonder voorwerpen te wijzigen. | items:write |
| GET /lost-found/queues | Toon de opgeslagen werkwachtrijen van de huidige maker van de sleutel op deze locatie. | lost_reports:read |
| PUT /lost-found/queues/{id} | Vervang je eigen opgeslagen wachtrij; onderliggende voorwerpen en claims blijven ongewijzigd. | lost_reports:write |
| DELETE /lost-found/queues/{id} | Verwijder je eigen opgeslagen wachtrij; onderliggende voorwerpen en claims blijven ongewijzigd. | lost_reports:write |
| POST /lost-found/queues | Sla een werkwachtrij met een naam op als voorinstelling voor de huidige maker van de sleutel. | lost_reports:write |
| GET /lost-found/queues/{id} | Lees de actuele dossiers achter een opgeslagen wachtrij. Binnenkomende verplaatsingen openen de bestaande weergave van de verplaatsing met bijbehorende rechten. | lost_reports:read, items:read, claims:read |
| POST /lost-found/intake-review | Geef deterministische meldingen over volledigheid en privacy terug; geen AI en geen wijzigingen. | items:read |
| GET /checkroom/templates | Toon sjablonen die alleen configuratie bevatten; alleen voor managers. | checkroom:read |
| PUT /checkroom/templates/{id} | Vervang een sjabloon als manager; onderliggende evenementen, posten en tickets blijven ongewijzigd. | checkroom:write |
| DELETE /checkroom/templates/{id} | Verwijder een sjabloon als manager; onderliggende evenementen, posten en tickets blijven ongewijzigd. | checkroom:write |
| POST /checkroom/templates | Sla de configuratie van de posten van een evenement op zonder gasten of tickets; alleen voor managers. | checkroom:write |
| POST /checkroom/templates/{id}/apply | Maak een nieuw evenement en nieuwe posten; botsingen met actieve nummerreeksen weigeren de hele bewerking. | checkroom:write |
Contactcenter en bewaring bij Lost & Found
Door mensen bediende integraties kunnen een melding van een gast aanmaken, een beoordeling van eigendom vastleggen, over een claim beslissen en het fysiek ophalen vastleggen. Nieuwe schrijfscopes moeten uitdrukkelijk worden gekozen; bestaande sleutels krijgen ze niet. Geen van deze schrijfacties voor claims of afhandeling wordt aangeboden als MCP-tool of Ask vFound-tool. Je integratie is verantwoordelijk voor het identificeren en autoriseren van de eigen menselijke bediener: het auditlog noemt de manager die de sleutel heeft aangemaakt en, wanneer de integratie X-Acting-User meestuurt, ook het teamlid dat daarin is genoemd en dat vFound niet authenticeert.
| Methode en pad | Wat het doet | Scope |
|---|---|---|
| POST /lost-reports | Intake via het contactcenter: first_name, last_name, email, title en description; optioneel phone, category id, colour_brand, place_lost, date_lost en language. Verstuurt de gebruikelijke bevestiging aan de gast en de privélink en start de bewaking van 90 dagen. Toestemming voor telefoon wordt nooit afgeleid. De bestaande limieten voor openstaande meldingen gelden. | lost_reports:write |
| PUT /lost-reports/{id} | Bewerk wat verloren is gegaan met de vingerafdruk die GET /lost-reports teruggeeft. Titel en beschrijving zijn verplicht. Een weggelaten journey behoudt de opgeslagen details; als het verzamelen is uitgeschakeld, worden wijzigingen in de context geweigerd. Wijzigingen in contactgegevens vragen om de aparte gecontroleerde contactflow. | lost_reports:write |
| GET /lost-reports/{id}/matches | Tot 24 actuele kandidaten op basis van tekst en categorie, elk met match.label, reason en source. Recent opgeslagen AI-oordelen gebruiken cached_ai; anders wordt een trefwoordsuggestie als possible gemarkeerd. Geen nieuwe modelaanroep en geen beslissing over eigendom. | lost_reports:read en items:read |
| GET /items/{id}/matches | Id en titel van de bijpassende melding zonder contactgegevens van de melder; tot 24 treffers uit de laatste 1,000 openstaande meldingen. Dezelfde bronlabels en geen nieuwe modelaanroep. | items:read en lost_reports:read |
| POST /claims/{id}/verification | Leg verified (boolean) en method (distinctive_details, purchase_proof of staff_review) vast. Verklaring door een mens, geen geautomatiseerde echtheidscontrole van documenten; geen kopie van een document en geen bewijs in vrije tekst. De laatste beoordeling moet slagen voordat de API een claim accepteert. | claims:write |
| POST /claims/{id}/decision | status: open, accepted, rejected, expired, ready_for_pickup, ready_for_shipment, shipped of handed_to_courier. De bestaande statusmachine en de tweede goedkeuring gelden. Velden voor handmatige verzending volgen de regels van de werkruimte. Bij accepted verplaatst een optionele return (pickup of shipment) de claim in hetzelfde verzoek naar die fase, met één e-mail aan de aanvrager; als een vrijgave van hoge waarde nog een tweede goedkeuring nodig heeft, blijft de claim accepted en zegt return_notice waarom (hetzelfde verzoek nogmaals wijzigt niets). Een optionele arranged_by (site of owner) geeft aan wie een koerier of postretour boekt, en elk antwoord over een claim toont dit. Zonder arranged_by betekent een bezorgadres in shipment (of een adres dat de claim al heeft) dat je team het opstuurt, zoals voorheen; anders beslist de Lost & Found-instelling van de locatie. owner betekent dat de eigen koerier van de aanvrager het voorwerp ophaalt: er wordt geen adres gevraagd, een adres dat met owner wordt meegestuurd wordt geweigerd en shipped wordt geweigerd. Als hun koerier het ophaalt, stuur je handed_to_courier met het koeriersbedrijf in shipment.carrier en zijn boekingsreferentie in shipment.tracking_number; de claim wordt afgesloten. Om te wijzigen wie het boekt, zet je de claim naar ready_for_pickup en weer naar ready_for_shipment met arranged_by. | claims:write |
| POST /claims/{id}/release-approval | Een andere manager keurt een geaccepteerde vrijgave van hoge waarde goed, met dezelfde controles als in de werkruimte. | claims:write |
| GET /claims/{id}/custody | Bekijk de geschiedenis van beoordeling en fasen, de goedkeurder en de naam en tijd van het ophalen. signature_recorded is een boolean; er wordt geen handtekeningafbeelding of privé bestandsadres getoond. | claims:read |
| POST /claims/{id}/handover | Leg het fysiek ophalen vast vanuit ready_for_pickup, met handover.name en, wanneer vereist, een PNG-data-URL in handover.signature. Herhaalde aanroepen voor een afgesloten claim behouden de eerste ontvangstbevestiging. | claims:write |
| POST /items/{id}/disposition | kind donated/disposed, recipient voor een schenking, optionele notes. De controles op de bewaartermijn en op openstaande of geaccepteerde claims gelden. Geeft de genummerde batchbevestiging terug. | items:write |
Gebruik een Idempotency-Key bij pogingen om te schrijven opnieuw te proberen. Een beoordeling is geen echtheidscontrole van een identiteitsdocument en keurt zelf geen eigendom goed. Het aanmaken van een eerste melding volgt de workflow voor gasten, inclusief AI die de locatie heeft ingeschakeld; GET-aanroepen voor lijsten met treffers gebruiken opgeslagen oordelen en alleen zoeken in tekst. Dit zijn algemene REST/OpenAPI-bewerkingen; er is geen WSO2-installatie of eigen connector gecertificeerd.
Een voorwerp toevoegen
curl https://vfound.io/api/v1/items -X POST \
-H "Authorization: Bearer $VFOUND_KEY" -H "Content-Type: application/json" \
-d '{"title":"Black leather wallet","category":"Wallets & Purses","found_date":"2026-09-23",
"location":"Front desk","colour":"Black","brand":"Fossil","tags":["leather","cards"],
"photo":"data:image/jpeg;base64,…","photo_public":true}'
Velden: title en category zijn verplicht. Optioneel: found_date, found_time (HH:MM), keep_until, location, description, colour, brand, tags, value_band (unknown, low, medium, high), notes (alleen voor medewerkers), photo (een base64-data-URL tot 8 MB) en photo_public. Foto's die via de API worden verstuurd, worden niet gecontroleerd door de privacybewaking van vFound AI, dus zet photo_public op false voor elke foto waarop persoonsgegevens te zien zijn.
Het voorwerpobject
{"id":"9b2f…","title":"Black leather wallet","status":"in_care","category":"Wallets & Purses",
"found_date":"2026-09-23","found_time":"14:30","keep_until":"2026-10-21","location":"Front desk",
"description":null,"colour":"Black","brand":"Fossil","tags":["leather","cards"],"value_band":"low",
"photo_public":true,"photo_url":"https://vfound.io/uploads/…","transfer":null,"created_at":"…","updated_at":"…"}
Status is een van in_care, in_transit (onderweg naar een andere locatie; transfer noemt dan beide locaties), claimed, expired, donated, disposed of trash. Een PATCH mag in_care, expired, donated, disposed of trash instellen; teruggaven aan een gast verlopen via claims.
Claims
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/claims | Claims, de laatst gewijzigde eerst. Filters: status, updated_since, page, per_page. | claims:read |
| GET/claims/{id} | Eén claim op basis van zijn referentie. | claims:read |
{"id":"k3f9x2a1b7c4d8e6","status":"ready_for_pickup","item":{"id":"9b2f…","title":"Black leather wallet"},
"claimant":{"first_name":"Ana","last_name":"Ruiz","email":"ana@example.com","phone":null},
"description":"…","place_lost":"Bar","date_lost":"2026-09-22","language":"es","arranged_by":null,"created_at":"…","updated_at":"…"}
Claimstatus: unread, open, accepted, awaiting_information, ready_for_pickup, ready_for_shipment, shipped, closed, rejected of expired (geaccepteerd maar nooit opgehaald). arranged_by geeft aan wie een koerier of postretour boekt: venue (je team stuurt het op) of owner (de eigen koerier van de aanvrager haalt het op); null wanneer de claim zo'n retour niet heeft. De gegevens van aanvragers zijn persoonsgegevens: bewaar ze alleen zolang je ze nodig hebt.
Verliesmeldingen
GET/lost-reports toont wat gasten als verloren hebben gemeld, met status (open of closed), de contactgegevens van de melder, de taal die ze gebruikten en een eventuele Find My-link die ze hebben gedeeld. Scope: lost_reports:read.
Analyses
GET/analytics?days=30 geeft dezelfde samenvatting terug als Rapporten: geregistreerde en teruggegeven voorwerpen, teruggavepercentage, mediaan van het aantal dagen tot teruggave, waar voorwerpen terechtkwamen, categorieën, hotspots, drukste dagen, werk van het team, de trend en feedback van gasten. days is 7, 30, 90 of 365. Scope: analytics:read.
Hotelverblijven
Verblijfscontext is privé voor de locatie en bewust minimaal. Hij bevat een vaste verblijfsreferentie, een optionele gastreferentie, de naam van de gast, aankomst en vertrek, de tijdzone van de bron, de huidige kamer, de status en tijdstempels van de bron. Hij bevat nooit tarieven, betaalgegevens, loyaliteitsgegevens, identiteitsdocumenten, voorkeuren of niet-gerelateerde reserveringsnotities.
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/stays | Verblijven tonen. Filters: search (gast, vaste referentie of huidige kamer), state, source, page en per_page. Een treffer op kamer helpt alleen bij het navigeren; hij suggereert nooit wie de eigenaar is. | stays:read |
| GET/stays/{stay} | Eén verblijf met de bijbehorende controleerbare geschiedenis van bron en correcties. | stays:read |
| POST/stays | Maak het API-brondossier aan of werk het bij, geïdentificeerd door external_stay_ref. Stuur source_updated_at mee; vertraagde of opnieuw afgespeelde gebeurtenissen die niet nieuwer zijn dan de opgeslagen gebeurtenis worden bevestigd zonder nieuwere gegevens te vervangen. | stays:write |
curl https://vfound.io/api/v1/stays -X POST \
-H "Authorization: Bearer $VFOUND_KEY" -H "Idempotency-Key: pms-event-901" \
-H "Content-Type: application/json" \
-d '{"external_stay_ref":"BOOK-100","guest_name":"Avery Chen","current_room":"412",
"stay_state":"in_house","source_timezone":"America/New_York","source_updated_at":"2026-10-03T12:00:00Z"}'
Voorwerpen en pakketten accepteren optioneel stay_id en room_at_event. Als de kamer ten tijde van de gebeurtenis wordt weggelaten, legt vFound de huidige kamer van het verblijf vast. Die momentopname verandert niet na een kamerwissel; het dossier toont ook de huidige kamer, zodat de balie beide ziet.
Parcels
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/parcels | Pakketten, de laatst gewijzigde eerst. Filters: status (waiting, collected of returned), search (ontvanger, unit, trackingnummer, afzender of ophaalcode), updated_since. | parcels:read |
| GET/parcels/{id} | Eén pakket. | parcels:read |
| POST/parcels | Registreer een pakket voor recipient_email (gekoppeld aan je personenlijst) of recipient_name, met optioneel unit, carrier, tracking, sender en shelf. De persoon krijgt zijn ophaalcode per e-mail, tenzij notify false is. | parcels:write |
| POST/parcels/{id}/collect | Overhandig het: collected_by (verplicht) en een optionele signature (een PNG-data-URL). | parcels:write |
| POST/parcels/{id}/return | Stuur het terug naar de afzender, met een optionele note. | parcels:write |
| POST/parcels/{id}/remind | Stuur de ontvanger een herinnering per e-mail om het op te halen. | parcels:write |
| POST/parcels/tracking | Normaliseer een trackingnummer en herken UPS, FedEx, USPS, DHL, Amazon of een internationale S10-vervoerder. Een geldige GS1 SSCC wordt geaccepteerd als zendingstracking; een GS1-productidentificatie wordt herkend maar nooit als pakketnummer behandeld. | parcels:read |
| GET/parcels/pickup-queue | Mensen die hebben aangegeven dat ze bij de balie zijn, met hun aantal pakketten en planken. | parcels:read |
| POST/parcels/pickup-queue/{id}/serve | Markeer één aankomst bij de balie als geholpen. | parcels:write |
| POST/parcels/bulk-remind | Stuur herinneringen per e-mail voor maximaal 200 geselecteerde wachtende pakketten. | parcels:write |
| POST/parcels/bulk-return | Stuur maximaal 200 geselecteerde wachtende pakketten terug naar de afzender. | parcels:write |
| GET/parcels/shelves | De capaciteit van de pakketplanken en de huidige bezetting. | parcels:read |
| POST/parcels/shelves | Maak een plank aan of wijzig de capaciteit ervan. | parcels:write |
| GET/parcels/analytics | Volume, verdeling per vervoerder, ophaaltijd, percentage niet opgehaald en drukste planken. | parcels:read |
| GET/parcels/outgoing | Uitgaande pakketten die klaarstaan voor een koerier of zijn overgedragen. | parcels:read |
| POST/parcels/outgoing | Registreer een uitgaand pakket. | parcels:write |
| POST/parcels/outgoing/{id}/handoff | Leg de koerier en handtekening vast bij de overdracht. | parcels:write |
| GET/parcels/rounds | Bezorgrondes en hun stops. | parcels:read |
| POST/parcels/rounds | Maak een ronde over de campus of het kantoor van wachtende pakketten. | parcels:write |
| POST/parcels/rounds/{round}/stops/{stop}/deliver | Rond een stop af met de naam van de ontvanger en een handtekening. | parcels:write |
| GET/parcels/couriers | Koeriers die via Visitors zijn geregistreerd, met status in of out. | parcels:read |
{"id":412,"status":"waiting","recipient":{"name":"Ana Ruiz","email":"ana@example.com","unit":"Room 214","reference":"S1044"},
"carrier":"UPS","tracking":"1Z999AA10123456784","sender":null,"size":"small","shelf":"B2","pickup_code":"KQHRER",
"notified_at":"…","collected_at":null,"collected_by":null,"returned_at":null,"created_at":"…","updated_at":"…"}
De ophaalcode wordt alleen getoond zolang het pakket wacht. De gegevens van ontvangers zijn persoonsgegevens: bewaar ze alleen zolang je ze nodig hebt.
Checkroom
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/checkroom/tickets | Tickets, de laatst gewijzigde eerst, met status (pending, in, returned, left of moved), het nummer, wat is ingeleverd, afzonderlijk gelabelde piece_records, de gegevens van de gast als die zijn opgegeven, de kosten die aan de balie zijn vastgelegd en de tijden. Filters: status, search (gast, kamer, ticketnummer, stuklabel of ticketcode), updated_since. | checkroom:read |
| GET/checkroom/tickets/{id} | Eén ticket. | checkroom:read |
| POST/checkroom/tickets | Check iets in en krijg het volgende vrije nummer: kind (coat, bag, luggage of other, verplicht), pieces, optioneel piece_details met één soort en opslagplek per stuk, guest_name, guest_email, guest_room, collect_by voor bagage, notes, fee_method (cash of card), station_id, event_id, storage_location, language en photo. Het antwoord bevat ook één keer guest_ticket (de code en het privéadres van het ticket), om als QR-code te tonen of voor de gast af te drukken; lezen, lijsten en webhooks bevatten het nooit. | checkroom:write |
| POST/checkroom/tickets/{id}/hand-back | Geef het terug zodra je systeem het ticket van de gast heeft gelezen, met optioneel collected_by en signature. Stuur piece_ids mee om geselecteerde stukken terug te geven en de andere open te laten; laat het weg om elk openstaand stuk terug te geven. without_ticket legt vast dat de gast zijn ticket kwijt is en vraagt dan om collected_by en signature. | checkroom:write |
| GET/checkroom/stations | Toon de checkroomposten, nummerreeksen en opslagplekken van de locatie. | checkroom:read |
| POST/checkroom/stations | Maak een post aan met een nummerreeks die niet overlapt. | checkroom:write |
| PUT/checkroom/stations/{id} | Wijzig een post, zijn nummerreeks, opslagplekken of actieve status. | checkroom:write |
| GET/checkroom/events | Toon recente en aankomende checkroomevenementen. | checkroom:read |
| POST/checkroom/events | Maak een evenement aan met het verwachte volume en de posten. | checkroom:write |
| PUT/checkroom/events/{id} | Wijzig de tijden, de prognose of de posten van een evenement. | checkroom:write |
| GET/checkroom/exit-queue | Tickets waarvan de gasten de balie hebben gevraagd hun spullen klaar te zetten. | checkroom:read |
| POST/checkroom/tickets/{id}/ready | Markeer een wachtend ticket als klaar en breng de gast op de hoogte. | checkroom:write |
| GET/checkroom/report | Ticketvolume, piekuren, teruggavetijd en kosten per methode en per medewerker. | checkroom:read |
| GET/checkroom/export | Download de rijen van het checkroomrapport als CSV die veilig is voor formules. | checkroom:read |
Queue
Rijen, de mensen die erin wachten en de balies waar ze naartoe worden geroepen. Elke wijziging doorloopt dezelfde stappen als aan de balie, met dezelfde geschiedenis, als de maker van de sleutel of het teamlid dat in X-Acting-User staat. Een ticket bevat nooit het e-mailadres van de gast of zijn antwoorden op de vragen van de rij.
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/queue/lines | Rijen met hun toestand nu, de mensen die wachten en een geschatte wachttijd voor wie nu aansluit. | queue:read |
| GET/queue/lines/{id} | Eén rij. | queue:read |
| GET/queue/tickets | Tickets van één dag van de locatie (day, standaard vandaag), in de volgorde van oproepen; filter op line en status. | queue:read |
| GET/queue/tickets/{id} | Eén ticket. | queue:read |
| GET/queue/report | Tickets, geholpen mensen, no-shows, mensen die zijn vertrokken, en mediane wacht- en servicetijd in minuten over de laatste days. | queue:read |
| POST/queue/tickets | Voeg een persoon toe aan een rij, zoals de balie dat doet. | queue:write |
| POST/queue/call-next | Roep de volgende persoon op naar een balie (counter_id). Twee oproepers krijgen nooit dezelfde persoon; data is null als er niemand wacht. | queue:write |
| POST/queue/tickets/{id}/call | Roep een gekozen persoon op naar een balie. | queue:write |
| POST/queue/tickets/{id}/served | Markeer de persoon bij een balie als geholpen. | queue:write |
| POST/queue/tickets/{id}/no-show | Markeer een opgeroepen persoon die niet is gekomen als no-show. | queue:write |
| POST/queue/tickets/{id}/remove | Haal een persoon uit de rij. | queue:write |
| GET/queue/bookings | Gereserveerde tijden, de vroegste eerst, met from, to, line, status en paginering. Nooit het e-mailadres van de persoon. | queue:read |
| POST/queue/bookings | Reserveer een van de vrije tijden van de pagina met gereserveerde tijden van een rij voor een persoon (line_id, starts_at, email). | queue:write |
| POST/queue/bookings/{id}/cancel | Annuleer een gereserveerde tijd; de persoon krijgt een e-mail dat het team hem heeft geannuleerd. | queue:write |
| POST/queue/bookings/{id}/arrived | Meld een persoon met een gereserveerde tijd aan; zijn ticket wordt geplaatst op basis van de gereserveerde tijd. | queue:write |
| POST/queue/tickets/{id}/arrived | Markeer een persoon die aansloot voordat hij er was als aanwezig. | queue:write |
| GET/queue/tickets/{id}/messages | De berichten tussen een persoon in de rij en het team, de oudste eerst. Door te lezen worden de berichten van de persoon als gelezen gemarkeerd. | queue:read |
| POST/queue/tickets/{id}/messages | Schrijf naar een persoon in de rij (body, 1 tot 500 tekens), als het teamlid van de sleutel. | queue:write |
| GET/queue/survey | Enquêtecijfers na afloop van de service: antwoorden, gemiddelde, elke beoordeling, per rij, service, balie en teamlid (het gemiddelde van een teamlid verschijnt vanaf 5 antwoorden). Nooit opmerkingen. | queue:read |
| GET/queue/performance | Gewone cijfers voor elk teamlid over dezelfde dagen als het rapport. Geen score en geen ranglijst. | queue:read |
| GET/queue/lines/{id}/slots | De open gereserveerde tijden van een rij, zoals de boekingspagina ervan ze aanbiedt. | queue:read |
| POST/queue/join | Neem een nummer voor een gast van je eigen website, volgens de regels voor gasten (open rij, limieten, verplichte antwoorden en toestemmingsvakjes). Stuur het vanaf je server: de sleutel vervangt de captcha. | queue:write |
| GET/queue/tickets/lookup | Zoek tickets op basis van het nummer dat de gast heeft. | queue:read |
| GET/queue/tickets/{id}/status | Wat de eigen ticketpagina van de gast toont: plaats, schatting en zin. | queue:read |
| GET/queue/tickets/{id}/history | De stappen van één ticket. Wie elke stap deed, is team, guest, api (aansluiten via een sleutel) of system (automatisch gedaan, zoals de automatische no-show), nooit een naam. | queue:read |
| GET/queue/customers/history | Bezoeken van iemand die heeft gevraagd te worden onthouden, gevonden via e-mailadres, zolang de locatie herkenning heeft ingeschakeld. Het vertelt de sleutelhouder of een e-mailadres bij een onthouden bezoeker hoort. | queue:read |
| GET/queue/insights | Tellingen over dezelfde dagen als het rapport: mensen die vertrokken voordat ze werden opgeroepen, mensen met een gereserveerde tijd en mensen zonder afspraak, het aandeel dat binnen het wachtdoel is opgeroepen per rij en week, en drukke uren uit eerdere weken. Alleen tellingen; nooit een naam of een antwoord. | queue:read |
| GET/queue/report-data | De Queue-tickets zoals de rapportbouwer ze leest (fields[], limit tot 1000, offset), voor BI-tools. De naam van de gast wordt nooit meegegeven. | queue:read |
Equipment
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/loans | Apparatuur die is uitgegeven, de laatst gewijzigde eerst, met status (out, returned of lost), of het overdue is, het artikel, de persoon en de tijden. Filters: status (out, returned, lost of overdue), search (naam, e-mailadres of referentie van de persoon), updated_since. | loans:read |
| GET/loans/{id} | Eén uitgifte. | loans:read |
| POST/loans | Geef iets uit: item_id of item_code (de code op het label, of de link in de QR-code), borrower_name (verplicht), optioneel person_id om de personenlijst te koppelen, borrower_email voor een bon, borrower_reference, due_at, note, language en signature. | loans:write |
| POST/loans/{id}/extend | Geef meer tijd: een nieuwe due_at. De persoon krijgt de nieuwe tijd per e-mail. | loans:write |
| POST/loans/{id}/return | Neem het in, met een optionele condition (good, damaged of incomplete), note en set_aside om het artikel opzij te leggen voor reparatie. | loans:write |
| POST/loans/returns | Neem meerdere dingen tegelijk in: loan_ids (1 tot 50), met dezelfde optionele condition, note en set_aside voor alle. Alles of niets: als er één al terug is of niet wordt gevonden, verandert er niets. Een persoon met een e-mailadres krijgt één bon voor elke uitgifte, met alles wat terugkwam, en elke uitgifte stuurt zijn eigen loan.returned-gebeurtenis. | loans:write |
| GET/loans/items | Alles wat de balie uitgeeft, op naam. Filters: status (available, out, repair of retired), search (naam, inventarislabel of labelcode), updated_since. | loans:read |
| GET/loans/items/{id} | Eén artikel, met de link die de QR-code van het label bevat. | loans:read |
| GET/loans/items/{id}/tickets | Tickets die naar de eigen Jira, Zendesk of ServiceNow van de locatie zijn gestuurd voor dit artikel (bèta), met de laatst teruggelezen status. | loans:read |
| POST/loans/items | Voeg apparatuur toe: name (verplicht), category, tag, location, notes, loan_hours (hoeveel uur het gewoonlijk wordt uitgegeven), photo, product en variant (units van één product en variant kunnen als één worden geboekt), en copies om maximaal 50 identieke, genummerde artikelen toe te voegen. | loans:write |
| PATCH/loans/items/{id} | Wijzig de gegevens, of zet status op available, repair of retired. product en variant wijzigen de productfamilie; cleaning_status needs_cleaning markeert het als wachtend op schoonmaak en null markeert het als schoongemaakt. Artikelen tonen product, variant, cleaning_status en cleaning_since. | loans:write |
| GET/loans/items/{id}/tag | Of een NFC- of RFID-tag is gekoppeld, en de laatste vier hexadecimale cijfers van het serienummer. | loans:read |
| PUT/loans/items/{id}/tag | Koppel een tag via zijn serienummer, zoals een telefoon het leest of een lezer die als toetsenbord typt het intypt (hex, omgekeerde hex of decimaal); het vervangt elke tag die het artikel had. | loans:write |
| DELETE/loans/items/{id}/tag | Verwijder de tag van het artikel. | loans:write |
| POST/loans/checkouts | Geef één tot 50 artikelen uit in één atomaire uitgifte, of geef een opgeslagen set uit. Het accepteert een persoon, inlevertijd, notitie en optionele handtekening, en voorraadregels (stock) die op dezelfde bon worden uitgegeven en teruggegeven in stock. custom_values stelt de eigen kenmerken van de locatie voor de uitgifte in. | loans:write |
| GET/loans/kits | Opgeslagen groepen apparatuur die meestal samen worden uitgegeven. | loans:read |
| POST/loans/kits | Sla een set op van in totaal minstens twee onderdelen: item_ids met naam, lines (een aantal van een categorie) en child_kit_ids (sets erin, tot drie niveaus), stock_lines (getelde voorraad die ermee wordt uitgegeven, nooit vastgehouden voor een boeking), optioneel locked zodat de artikelen met naam alleen samen worden uitgegeven. | loans:write |
| PUT/loans/kits/{id} | Wijzig een opgeslagen set en zijn artikelen. | loans:write |
| GET/loans/trainings | De trainingen die een categorie of artikel kan vereisen voordat iemand het meeneemt (in te stellen onder Equipment, Beleid, Training). | loans:read |
| GET/loans/trainings/{id}/holders | Wie een training heeft, vanaf wanneer en tot wanneer, en of die is verlopen. | loans:read |
| POST/loans/trainings/{id}/holders | Geef een persoon op de personenlijst een training, of verleng hem, met een optioneel bewijsdocument. | loans:write |
| DELETE/loans/trainings/{id}/holders/{person} | Neem een training weg bij een persoon, met zijn bewijsdocument. | loans:write |
| GET/loans/borrower-types | De persoonstypen: de artikellimiet, gebruikelijke duur en de categorieën die de mensen van elk type zien en kunnen meenemen (in te stellen onder Equipment, Beleid, ‘Gebruikerstypen’). Een lege limiet of duur betekent dat die van de locatie zelf geldt. | loans:read |
| GET/loans/borrower-types/{id}/members | Wie een persoonstype heeft. | loans:read |
| POST/loans/borrower-types/{id}/members | Geef mensen op de personenlijst een persoonstype (tot 500 tegelijk). | loans:write |
| PUT/loans/borrower-types/{id}/members/{person} | Wijzig het lidmaatschap van een persoon van een persoonstype: de begindag, de einddag (daarna zien ze nog wat het type toont, maar kunnen ze het niet reserveren of meenemen) en een notitie over waar een bedrag is afgeschreven. vFound neemt geen betaling aan. | loans:write |
| DELETE/loans/borrower-types/{id}/members/{person} | Neem een persoonstype weg bij een persoon. | loans:write |
| GET/loans/credits | Recent gegeven boekingstegoeden en het saldo van één persoon. Tegoeden zijn een aantal dat boekingen verbruiken, nooit geld. | loans:read |
| POST/loans/credits | Geef een persoon boekingstegoeden, of neem er terug met een negatief getal (eigenaren en managers). | loans:write |
| GET/loans/holds | Actieve blokkades op het meenemen: zolang er een duurt, wordt er niets aan de persoon uitgegeven en kan die niet boeken. | loans:read |
| POST/loans/holds | Zet een blokkade op het meenemen door een persoon, met een optionele reden (bewaard voor het team, nooit in de e-mail), eindtijd en e-mail aan de persoon. | loans:write |
| POST/loans/holds/{id}/lift | Hef een blokkade op. | loans:write |
| GET/loans/spaces | Kamers, werkplekken, parkeerplaatsen en andere plekken die de locatie voor een bepaalde tijd boekt, optioneel gefilterd op type. Elk is een artikel met kind space, dat nooit wordt uitgegeven. | loans:read |
| POST/loans/spaces | Voeg een kamer of ruimte toe met zijn type, hoeveel mensen erin passen en waar hij is. | loans:write |
| PUT/loans/spaces/{id} | Wijzig een kamer of ruimte. | loans:write |
| GET/loans/spaces/availability | Elke kamer of ruimte met zijn open boekingen tussen from en to (tot 31 dagen), met de naam van de persoon, hoeveel mensen komen en eventuele instructies voor de inrichting. | loans:read |
| POST/loans/spaces/{id}/book | Boek een kamer of ruimte voor een persoon en tijd, alleen of samen met apparatuur (alles of niets), met instructies voor de inrichting voor het team. | loans:write |
| POST/loans/reservation-groups/{id}/parts | Voeg één artikel, of één uit een categorie, toe aan een boeking van een set of winkelwagen, gecontroleerd als een nieuwe boeking. Geweigerd voor een vergrendelde set. Een onderdeel uit een categorie die het risicoformulier van de locatie dekt, vraagt om risk_answers, en de beoordeling van de boeking wacht op een nieuwe controle. | loans:write |
| POST/loans/reservations/{id}/remove-part | Haal één onderdeel uit een boeking van een set of winkelwagen; het laatste onderdeel wordt geannuleerd met de boeking. | loans:write |
| GET/loans/places | De eigen geneste plekken van de locatie: gebouwen, kamers, planken, bouwplaatsen en vrachtwagens. De place_id van een artikel bepaalt waar het staat en vult zijn location en sub_location. | loans:read |
| GET/loans/category-tree | De categorieën apparatuur gegroepeerd in een boom, de bovenliggende eerst. Regels en boekingen gelden nog steeds voor de eigen categorie van een artikel. | loans:read |
| GET/loans/asset-models | Modellen waarvan nieuwe artikelen worden gemaakt. Stuur asset_model_id mee bij POST /loans/items om elk leeggelaten detail in te vullen. | loans:read |
| GET/loans/items/{id}/links | De koppelingen van een artikel met andere artikelen van dezelfde locatie: werkt samen met, een alternatief, vervangt. | loans:read |
| POST/loans/items/{id}/links | Koppel een artikel aan een ander van dezelfde locatie, met een notitie. | loans:write |
| DELETE/loans/items/{id}/links/{link} | Verwijder een koppeling bij beide artikelen. | loans:write |
| POST/loans/kits/{id}/move | Verplaats een set naar een plek van de locatie: elk artikel met naam erin, en in de sets erin, gaat in één keer daarheen (eigenaren en managers). | loans:write |
| GET/loans/items/{id}/meter-readings | Meterstanden die voor een artikel zijn ingevoerd, de nieuwste eerst. | loans:read |
| POST/loans/items/{id}/meter-readings | Leg een meterstand vast. Een onderhoudsschema met every_meter is aan de beurt zodra de meter zo ver is gelopen; standen gaan alleen omhoog. | loans:write |
| GET/loans/contracts | Contracten met leveranciers, gekoppeld aan de artikelen die ze dekken (eigenaren en managers). | loans:read |
| GET/loans/resale | Artikelen die te koop staan, met hun vraagprijs en boekwaarde (eigenaren en managers). Alleen een lijst: er wordt niets geadverteerd of verkocht. | loans:read |
| GET/loans/points | Ophaal- en inleverpunten die een boeking kan noemen. | loans:read |
| POST/loans/points | Voeg een punt toe (eigenaren en managers). Een boeking noemt er één om op te halen en één om in te leveren met pickup_point_id en dropoff_point_id. | loans:write |
| PUT/loans/points/{id} | Wijzig een punt of schakel het uit. | loans:write |
| GET/loans/projects | Projecten waartoe een boeking kan behoren. Er wordt niets voor een project opgehaald totdat het is goedgekeurd. | loans:read |
| POST/loans/projects | Voeg een project toe (wacht op goedkeuring). | loans:write |
| POST/loans/projects/{id}/decision | Keur een project goed of af (eigenaren en managers). | loans:write |
| GET/loans/risk-assessments | Risicobeoordelingen die op een controle wachten (of op status), met de antwoorden van de persoon. | loans:read |
| POST/loans/risk-assessments/{id}/review | Keur een risicobeoordeling goed of af (eigenaren en managers). Bij een afwijzing wordt de boeking geannuleerd. | loans:write |
| POST/loans/reservation-series | Boek één artikel, één categorie of één kamer of ruimte elke dag of week (repeat: frequency, every, weekdays, count of until, skip_conflicts). Elke keer volgt de boekingsregels en telt de keren ervoor mee; er wordt niets geboekt als er één bezet is, tenzij skip_conflicts aan staat. Hoogstens 52 keer, binnen een jaar. | loans:write |
| POST/loans/reservations/{id}/move | Verplaats een reservering, met elk onderdeel van een set of winkelwagen samen geboekt, naar nieuwe tijden of een ander artikel van dezelfde categorie. Opnieuw gecontroleerd als een nieuwe boeking; alles of niets. | loans:write |
| GET/loans/waitlist | Mensen die wachten op een tijd die al bezet was, op status (standaard waiting). | loans:read |
| POST/loans/waitlist | Zet iemand op de wachtlijst voor een artikel, een categorie of een ruimte en een tijd. Wanneer die vrijkomt, wordt de eerste persoon voor wie de tijd nu past geboekt en per e-mail op de hoogte gebracht. | loans:write |
| POST/loans/waitlist/{id}/cancel | Haal iemand van de wachtlijst. | loans:write |
| GET/loans/fees | Het grootboek van de kosten, de nieuwste eerst (filter op party_key, kind, status, billing_code, from, to), met de kosteninstellingen van de locatie en iedereen die iets verschuldigd is of een borg heeft staan. Bedragen zijn gehele getallen in de kleinste eenheid van de valuta. vFound registreert kosten; het verwerkt nooit een betaling. | loans:read |
| GET/loans/fees/party | Eén persoon (person_id of party_key): wat die verschuldigd is per valuta, borgen die worden vastgehouden, boekingen en facturen. | loans:read |
| GET/loans/fees/billing-codes | Gerekend, kwijtgescholden, verrekend en nog verschuldigd per factureringscode en valuta voor een periode; format=csv voor een CSV. | loans:read |
| POST/loans/fees/charges | Leg een vergoeding voor schade, vervanging of iets anders vast, of een kostenpost met een prijs via fee_template_id. De belasting van de locatie is van toepassing, tenzij taxable false is. | loans:write |
| POST/loans/fees/payments | Leg geld vast dat de locatie zelf heeft ontvangen (contant, het eigen pinapparaat, een overschrijving). Het verrekent openstaande bedragen, de oudste eerst. | loans:write |
| POST/loans/fees/deposits | Leg een borg vast die de locatie heeft ontvangen; vastgehouden totdat hij wordt teruggegeven of ingehouden. | loans:write |
| POST/loans/fees/deposits/{id}/return | Geef een vastgehouden borg terug. | loans:write |
| POST/loans/fees/deposits/{id}/keep | Houd een vastgehouden borg of een deel ervan in (eigenaren en managers, met een reden); het ingehouden deel telt als betaling. | loans:write |
| POST/loans/fees/{id}/waive | Scheld af wat een bedrag nog nodig heeft (eigenaren en managers, met een reden). | loans:write |
| POST/loans/fees/{id}/void | Maak een per ongeluk vastgelegde betaling ongeldig (eigenaren en managers, met een reden). Als je de betaling ongeldig maakt waarmee een borg is ingehouden, wordt dat bedrag weer als borg vastgehouden. | loans:write |
| GET/loans/{id}/fees | Wat de balie wordt aangeboden voor een uitgifte die terug is: de boete voor te laat die nog niet is vastgelegd, de vervangingswaarde bij verlies of schade, vastgehouden borgen. | loans:read |
| POST/loans/{id}/late-fine | Voeg de boete voor te laat toe voor een uitgifte die te laat terugkwam, gerekend vanaf het moment van terugkomen. Eén keer per uitgifte. | loans:write |
| GET/loans/invoices | Facturen, het nieuwste nummer eerst. | loans:read |
| POST/loans/invoices | Geef een genummerde factuur uit voor de openstaande bedragen van een persoon in één valuta. | loans:write |
| POST/loans/invoices/{id}/void | Maak een factuur ongeldig (eigenaren en managers, met een reden); met reissue komen de openstaande bedragen op een nieuwe die hem vervangt. | loans:write |
| GET/loans/reservations | Reserveringen op begintijd, optioneel gefilterd op status of from. | loans:read |
| POST/loans/reservations | Reserveer een specifiek artikel of één artikel in een categorie voor een persoon en tijdvak. custom_values stelt de eigen kenmerken van de locatie voor de boeking in. | loans:write |
| POST/loans/reservations/{id}/approve | Keur een reservering goed die op controle wacht. Als de locatie goedkeuringsstappen heeft, ondertekent een sleutel een stap alleen voor het teamlid dat in X-Acting-User staat, ondertekent een assistentverbinding er nooit een en ondertekent niemand een stap van een boeking die hij zelf heeft gemaakt (approval_not_yours). Boeken over een conflict heen volgt dezelfde regel. | loans:write |
| POST/loans/reservations/{id}/cancel | Annuleer een reservering die in behandeling is, goedgekeurd is of klaarstaat. | loans:write |
| POST/loans/reservations/{id}/pickup | Geef het gereserveerde artikel atomair mee en sluit de reservering af als opgehaald. | loans:write |
| POST/loans/reservation-groups | Reserveer een set (kit_id) of een winkelwagen (items: per regel een artikel, of een categorie en aantal) voor één persoon en tijdvak: elk onderdeel of geen. Goedkeuren, annuleren of ophalen van een onderdeel geldt voor elk open onderdeel. | loans:write |
| GET/loans/downtimes | Datumperiodes waarin één artikel niet kan worden geboekt of uitgegeven en die nog niet zijn afgelopen (item_id beperkt tot één artikel). | loans:read |
| POST/loans/downtimes | Voeg een periode toe aan een artikel: loan_item_id, starts_at, ends_at en een optionele reason. Geweigerd zolang een boeking of uitgifte het artikel voor een deel van die tijd vasthoudt. | loans:write |
| DELETE/loans/downtimes/{id} | Verwijder een periode. | loans:write |
| GET/loans/extra-values/{type}/{id} | De eigen kenmerken van de locatie voor een persoon (person), een reservation of een checkout, met de velden die voor dat soort dossier zijn gedefinieerd. | loans:read |
| PUT/loans/extra-values/{type}/{id} | Stel die kenmerken in, gecontroleerd aan de hand van de velden van de locatie en hun voorwaarden voor tonen. | loans:write |
| GET/loans/closures | Dagen dat de balie voor apparatuur gesloten is en die nog niet zijn afgelopen. | loans:read |
| POST/loans/closures | Voeg een sluiting toe: starts_on en ends_on als datums in de tijdzone van de locatie, tot 366 dagen. Een optionele note blijft intern; public_message (tot 300 tekens) wordt aan mensen getoond. Bestaande notities worden nooit gekopieerd naar het bericht voor mensen. | loans:write |
| DELETE/loans/closures/{id} | Verwijder een sluiting. | loans:write |
| GET/loans/rules | Standaardwaarden van de locatie, categorieregels voor duur, limieten, blokkades bij te laat, goedkeuring en boekingsregels (buffers tussen boekingen, minimale vooraankondiging, hoe ver vooruit) en sluitingen. | loans:read |
| POST/loans/rules | Maak één categorieregel aan of vervang hem. Weggelaten velden van boekingsregels behouden hun opgeslagen waarden. | loans:write |
| GET/loans/timeline | Controles van de capaciteit van artikelen of categorieën per hele dag. Verplichte from- en until-data, inclusief, in lokale tijd van de locatie, hoogstens 31 dagen vanaf vandaag tot en met volgend jaar; optioneel group=item|category, item_id, exacte category, page (50 rijen). Cellen zijn true, false of null (onzeker). Aangrenzende dagen garanderen geen ononderbroken boeking. | loans:read |
| GET/loans/warranties | Vastgelegde garantiedata; filter=soon|expired|all, exacte category, page (50 rijen). Soon omvat vandaag tot 30 dagen vooruit. Een persoonlijke aanmelding voor herinneringen staat in de werkruimte. | loans:read |
| GET/loans/utilization | Verstreken uren per object op basis van de vastgelegde statusgeschiedenis. Verplichte from- en until-data, inclusief, in lokale tijd van de locatie, binnen de laatste 365 dagen en begrensd op nu; optioneel item_id, exacte category, format=csv. JSON geeft exacte seconden; uren in CSV hebben zes decimalen. Beschikbaar omvat uitgegeven tijd; tijd voor reparatie of service en andere onbeschikbare tijd worden niet meegeteld. Eerdere stilstand is onbekend. De totalen sluiten aan op de rijen per object. | loans:read |
| GET/loans/maintenance | De geschiedenis van service, kalibratie, veiligheidstest, inspectie, schoonmaak, reparatie en notities; filter op artikel, aankomend werk of werkopdrachten (open of alle) en hun technicus. | loans:read |
| POST/loans/maintenance | Leg onderhoud en de volgende keer dat het aan de beurt is vast voor een artikel. Met plan_id het werk dat is gedaan voor een terugkerend schema, dat zijn volgende ronde start. | loans:write |
| GET/loans/service-plans | Terugkerende schema's voor service, kalibratie, veiligheidstest, inspectie en schoonmaak, met of elk aan de beurt is op datum, aantal uren uitgegeven of aantal uitgiftes. | loans:read |
| POST/loans/service-plans | Voeg een terugkerend schema toe aan een artikel (eigenaren en managers). | loans:write |
| PUT/loans/maintenance/{id} | Wijzig een werkopdracht of sluit hem af: status, technicus, leverancier, kosten, en bij done het resultaat en of het artikel weer in gebruik gaat. | loans:write |
| GET/loans/maintenance/costs | Kosten van service, reparatie en schoonmaak per artikel, uit afgeronde regels en afgeronde werkopdrachten. | loans:read |
| GET/loans/items/{id}/lifecycle | Het dossier van aankoop, afschrijving, verzekering en afstoting van een artikel, met zijn waarde van vandaag (eigenaren en managers). | loans:read |
| PUT/loans/items/{id}/lifecycle | Sla de aankoopprijs, datum, leverancier en bestelling op, de afschrijvingsmethode (lineair of degressief), levensduur en restwaarde, en de verzekering (eigenaren en managers). | loans:write |
| POST/loans/items/{id}/dispose | Leg vast hoe een artikel is vertrokken (verkocht, afgevoerd, geschonken, gerecycled, verloren of gestolen); het wordt buiten gebruik gesteld en zijn open boekingen en werkopdrachten worden geannuleerd. | loans:write |
| DELETE/loans/items/{id}/dispose | Maak een per ongeluk gedane afstoting ongedaan; het artikel is weer beschikbaar. | loans:write |
| GET/loans/valuation | De waarde van de apparatuur op een datum, tot op de cent, met totalen voor wat nog wordt aangehouden (eigenaren en managers). | loans:read |
| POST/loans/service-plans/import | Controleer of voeg schema's toe vanuit een CSV met de gedocumenteerde kolommen, met apparatuur die bij inventarislabel wordt genoemd (eigenaren en managers). | loans:write |
| POST/loans/maintenance/work-orders/import | Controleer of voeg open werkopdrachten toe vanuit een CSV met de gedocumenteerde kolommen (eigenaren en managers). | loans:write |
| GET/loans/maintenance/planner | Gepland werk en open werkopdrachten per eigen dag van de locatie voor maximaal 62 dagen, optioneel voor één technicus. | loans:read |
| GET/loans/funding | Wat elk fonds, elke subsidie of kostenplaats heeft gekocht en welk werk eraan is toegerekend, te filteren op fonds en data (eigenaren en managers). Alleen een registratie: vFound neemt geen betaling aan. | loans:read |
| GET/loans/substances | Het register van gevaarlijke stoffen: stof, plek, gevarenklassen en data van beoordeling. Een registratie van wat de locatie zegt; vFound geeft geen veiligheidsadvies. | loans:read |
| POST/loans/substances | Voeg een stof toe, met zijn veiligheidsinformatieblad als PDF of foto (eigenaren en managers). | loans:write |
| PUT/loans/substances/{id} | Wijzig een stof of vervang zijn informatieblad (eigenaren en managers). | loans:write |
| DELETE/loans/substances/{id} | Verwijder een stof en zijn bewaarde informatieblad (eigenaren en managers). | loans:write |
| GET/loans/licences | Licenties voor de apparatuur van de locatie met aantal gebruikers, einddatum en de artikelen waarop ze zijn geïnstalleerd (eigenaren en managers). Er wordt geen licentiesleutel opgeslagen. | loans:read |
| POST/loans/licences | Voeg een licentie toe (eigenaren en managers). | loans:write |
| PUT/loans/licences/{id} | Wijzig een licentie en waar die is geïnstalleerd. | loans:write |
| DELETE/loans/licences/{id} | Verwijder een licentie. | loans:write |
| GET/loans/expiries | Verzekeringen en licenties die binnenkort aflopen of al zijn afgelopen (eigenaren en managers). | loans:read |
| GET/loans/stocktakes | Recente inventarisaties van apparatuur met aantallen gescand en ontbrekend. | loans:read |
| POST/loans/stocktakes | Start één open inventarisatie voor de locatie, voor alles, voor één plek, categorie of set, of voor wat één persoon heeft (custodian_id), optioneel toegewezen aan een teamlid (assigned_to). | loans:write |
| POST/loans/stocktakes/{id}/scan | Scan een label van apparatuur, een inventarislabel of een serienummer in de open inventarisatie. | loans:write |
| POST/loans/stocktakes/{id}/scan-many | Tel tot 2,000 codes tegelijk (een RFID-lezer die als toetsenbord typt, of een lijst); elke code telt één keer en codes zonder match komen terug. | loans:write |
| PUT/loans/stocktakes/{id}/assign | Geef de open inventarisatie aan één teamlid om te tellen (assigned_to), of aan niemand (null). | loans:write |
| POST/loans/stocktakes/{id}/finish | Rond de inventarisatie af en geef de lijst met ontbrekende artikelen terug. | loans:write |
| GET/loans/stocktake-schedules | Inventarisaties die vanzelf openen, eenmalig of terugkerend. | loans:read |
| POST/loans/stocktake-schedules | Plan een inventarisatie, eenmalig, wekelijks, maandelijks, elke drie maanden of jaarlijks, op de eigen tijd van de dag van de locatie. | loans:write |
| PATCH/loans/stocktake-schedules/{id} | Wijzig, pauzeer of hervat een schema. | loans:write |
| DELETE/loans/stocktake-schedules/{id} | Verwijder een schema; inventarisaties die het heeft geopend blijven bestaan. | loans:write |
| GET/loans/last-seen | Waar elk artikel voor het laatst is gescand, wanneer de locatie scanposities bewaart (alleen teamleden die hebben ingestemd; nooit vanuit een sleutel). | loans:read |
| GET/loans/transfers | Binnenkomende en uitgaande verplaatsingen van apparatuur voor deze locatie. | loans:read |
| POST/loans/transfers | Maak apparatuur klaar voor een andere bevoegde locatie in dezelfde klantgroep. | loans:write |
| POST/loans/transfers/{id}/send | Leg vast dat klaargemaakte apparatuur de bronlocatie heeft verlaten. | loans:write |
| POST/loans/transfers/{id}/receive | Ontvang apparatuur op de bestemming, met de plek en de staat bij aankomst. | loans:write |
| POST/loans/transfers/{id}/cancel | Annuleer een klaargemaakte verplaatsing voordat die wordt verzonden. | loans:write |
| POST/loans/transfers/{id}/reject | Wijs een klaargemaakte verplaatsing op de bestemming af voordat die wordt verzonden. | loans:write |
| POST/loans/transfers/{id}/exception | Leg een probleem vast terwijl apparatuur onderweg is. | loans:write |
| POST/loans/import | Bekijk een voorbeeld van of importeer tot 5,000 CSV-rijen met kopteksten van vFound, Snipe-IT, Sortly of Cheqroom. | loans:write |
Visitors
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/visitors | Bezoeken, de laatst gewijzigde eerst, met status (expected, in, out, cancelled of missed), de bezoeker, de gastheer, de passcode zolang die geldig is, en de tijden. Filters: status, search (bezoeker, bedrijf, gastheer of passcode), updated_since. | visitors:read |
| GET/visitors/{id} | Eén bezoek. | visitors:read |
| POST/visitors | Nodig een bezoeker uit of meld er een aan. Het accepteert de velden voor bezoeker, gastheer en tijd, plus visitor_type_id, antwoorden, geldige data en een terugkeerpatroon per dag of op werkdagen. | visitors:write |
| POST/visitors/{id}/sign-in | Meld een verwachte bezoeker aan; de gastheer wordt op de hoogte gebracht. Stuur answers mee voor een groepslid van wie het type verplichte vragen heeft, en id_expires_on met identity_checked wanneer de locatie de vervaldatum van een fysiek ID vastlegt. Het bezoek bevat dan id_expires_on en id_expired. | visitors:write |
| POST/visitors/{id}/group/sign-in | Meld iedereen in de groep van het bezoek aan die vandaag wordt verwacht, met één e-mail aan de gastheer; wie een eigen foto, ID-controle, handtekening, antwoorden of voorwaarden nodig heeft, staat vermeld in skipped. | visitors:write |
| POST/visitors/{id}/sign-out | Meld ze af. | visitors:write |
| POST/visitors/{id}/cancel | Annuleer een uitnodiging. | visitors:write |
| POST/visitors/{id}/send-pass | Stuur de pas opnieuw per e-mail. | visitors:write |
| POST/visitors/{id}/approve | Keur een bezoek goed dat in behandeling is en stuur de pas. | visitors:write |
| POST/visitors/{id}/deny | Wijs een bezoek af dat in behandeling is. | visitors:write |
| GET/visitors/{id}/badge | Download de badge die in de browser kan worden afgedrukt. Kies size 4x3, brother of dymo. | visitors:read |
| GET/visitors/{id}/card | Of het bezoek een RFID-kaart heeft en de laatste vier tekens ervan (nooit het nummer). Uit totdat de locatie Kaarten en sleutelhangers inschakelt. | visitors:read |
| POST/visitors/{id}/card | Geef een verwacht of aangemeld bezoek een kaart via het nummer ervan; één nummer is tegelijk bij één bezoek actief. | visitors:write |
| DELETE/visitors/{id}/card | Neem de kaart terug. | visitors:write |
| GET/visitors/{id}/assets | De dingen die aan het bezoek zijn meegegeven, met de hand ingevoerd. | visitors:read |
| POST/visitors/{id}/assets | Leg een ding vast dat aan het bezoek is meegegeven, met een optionele tag. | visitors:write |
| POST/visitors/{id}/assets/{asset}/return | Markeer een ding als teruggebracht. | visitors:write |
| GET/visitor-assets/not-returned | Dingen die aan bezoekers zijn meegegeven en nog niet zijn teruggebracht, de nieuwste eerst. | visitors:read |
| GET/visitors/{id}/fast-track | Of het bezoek een actieve fast-trackcode heeft, tot wanneer en hoe vaak die is gebruikt (nooit de code zelf, die alleen de bezoeker ziet). | visitors:read |
| POST/visitors/{id}/fast-track | Geef een terugkerende bezoeker een fast-trackcode die days (1 tot 365) geldig is. | visitors:write |
| DELETE/visitors/{id}/fast-track | Neem de code terug. | visitors:write |
| GET/visitor-types | Toon bezoekerstypen en hun vragen, voorwaarden, badges, goedkeuringen en bewaartermijn (retention_days is null wanneer het type de standaardinstelling van de locatie volgt). | visitors:read |
| POST/visitor-types | Maak een bezoekerstype aan. | visitors:write |
| PATCH/visitor-types/{id} | Wijzig de velden van het bezoekerstype die je meestuurt. | visitors:write |
| DELETE/visitor-types/{id} | Deactiveer een bezoekerstype zonder eerdere bezoeken te wijzigen. | visitors:write |
| GET/visitor-roll-call | Haal het laatste appèl op, met de live tellingen. Een lopend appèl voegt iedereen toe die zich heeft aangemeld sinds het begon; een appèl dat 6 uur blijft lopen, wordt gesloten. | visitors:read |
| POST/visitor-roll-call | Start een appèl, optioneel met bezoekers die vandaag worden verwacht en iedereen die op goedkeuring wacht. | visitors:write |
| PATCH/visitor-roll-call/entries/{entry} | Markeer één regel als veilig of vermist. | visitors:write |
| POST/visitor-roll-call/{id}/finish | Rond het actieve appèl af en bewaar het rapport. | visitors:write |
| GET/staff-attendance | Toon de aanwezigheid van medewerkers voor een datumbereik op de klok van de locatie (standaard vandaag, hoogstens 366 dagen), of alleen mensen die nu zijn aangemeld met open=true. Bevat nooit het e-mailadres van de persoon. | visitors:read |
| POST/staff-attendance | Meld een persoon op de medewerkerslijst aan (mode office of remote) of af, met dezelfde regels als de balie. Vereist dat aanmelden voor medewerkers op de locatie is ingeschakeld. | visitors:write |
| POST/staff-presence | Stuur tot 50 aanwezigheidsgebeurtenissen (in, out of muster) vanuit je badge-, prikklok- of wifisysteem, elk met een persoon op de medewerkerslijst, genoemd via referentie, extern ID of e-mailadres. Vereist dat aanmelden voor medewerkers en de aanwezigheidsfeed op de locatie zijn ingeschakeld. Antwoordt wat er per gebeurtenis gebeurde, nooit wie. | visitors:write |
| POST/visitors/{id}/catering | Maak, wijzig of (zonder artikelen) verwijder het cateringverzoek van een verwacht of aangemeld bezoek, uit de opties die de locatie opgeeft. Stuurt één e-mail naar de cateringpostbus van de locatie; vFound bestelt niets en neemt geen betaling aan. Vereist dat catering op de locatie is ingeschakeld. | visitors:write |
| GET/workplace/spaces | Toon de werkplekken, vergaderruimtes en parkeerplaatsen die mensen op de locatie mogen boeken. | visitors:read |
| GET/workplace/free | Zoek ruimtes die vrij zijn voor een hele tijd (hoogstens 7 dagen), met uitzondering van een werkplek die voor een andere persoon wordt vrijgehouden. | visitors:read |
| GET/workplace/bookings | Toon boekingen van werkplekken, kamers en parkeerplaatsen in een periode van hoogstens 31 dagen. Bevat nooit het e-mailadres van de persoon. | visitors:read |
| POST/workplace/bookings | Boek een ruimte voor een persoon, eenmalig of als terugkerende boeking (dagelijks of wekelijks, tot 52 keer, alles of niets), volgens de reserveringsregels van Equipment. | visitors:write |
| POST/workplace/bookings/{id}/cancel | Annuleer een boeking, of met scope following of series de latere tijden ervan. | visitors:write |
| POST/workplace/bookings/{id}/check-in | Check een boeking in, vanaf 15 minuten voordat die begint totdat die eindigt. | visitors:write |
| POST/visitors/{id}/room | Boek een vergaderruimte voor een bezoek, vanaf de tijd van het bezoek; de ruimte volgt het bezoek. | visitors:write |
| GET/appointment-pages | Toon de afsprakenpagina's van de locatie, hun uren en of elke nu openstaat voor bezoekers. | visitors:read |
| GET/visitor-roll-call/archive | Toon afgesloten appèls (noodgevallen, oefeningen en mededelingen), de nieuwste eerst. | visitors:read |
| GET/visitor-roll-call/{id} | Eén appèl met zijn mensen, tijdlijn, controlerondes en aantallen berichten. | visitors:read |
| POST/visitor-roll-call/{id}/people | Voeg een persoon (een medewerker, anders of een aannemer) toe aan het lopende appèl. | visitors:write |
| POST/visitor-roll-call/{id}/scan | Markeer een bezoeker als veilig via zijn passlink of code, bij een verzamelpunt. | visitors:write |
| POST/visitor-roll-call/{id}/sweeps | Leg vast dat een zone is gecontroleerd en leeg is, of dat er mensen in zijn. | visitors:write |
| POST/visitor-roll-call/{id}/messages | Stuur een bericht naar iedereen, naar mensen die nog niet veilig zijn of naar mensen die hulp nodig hebben. Het gaat per e-mail, browsermelding en, via de eigen aanbieder van de locatie, sms of WhatsApp, met een privélink om te antwoorden dat ze veilig zijn of hulp nodig hebben. | visitors:write |
| GET/visitor-roll-call/{id}/people/{entry}/messages | Het gesprek met één persoon in een appèl: wat het team hun stuurde en wat ze terugschreven via hun privélink, de oudste eerst. Schrijf terug met het berichten-endpoint en audience entry. | visitors:read |
| POST/visitor-hazard-alerts | Een waarschuwing die een teamlid schrijft en naar een gekozen groep stuurt: hazard, message en group (on_site, visitor_type, host of tenant, met group_ref). Het start een appèl van het soort hazard voor die groep. vFound leest geen weer-, nieuws- of dreigingsfeed: er wordt niets verstuurd tenzij jij dit verzoek stuurt. Antwoordt 409 zolang een ander appèl loopt. | visitors:write |
| POST/visitor-help-alerts | Vraag stilletjes om hulp: de teamleden die daarvoor zijn gekozen worden op de hoogte gebracht; geen enkele bezoeker ziet iets. | visitors:write |
| GET/visitor-kiosks | Toon gekoppelde, wachtende en ingetrokken kioskapparaten. | visitors:read |
| POST/visitor-kiosks/pairing | Maak een koppelcode van acht tekens aan die tien minuten geldig is. | visitors:write |
| DELETE/visitor-kiosks/{id} | Trek een kioskapparaat in. | visitors:write |
| PUT/visitor-kiosks/{id}/settings | Wijzig de instellingen van één kiosk: een e-mail wanneer hij een aantal minuten niet is gezien, terug naar het begin na een rustige periode, een handtekening bij het aanmelden en het afdrukken van de badge vanaf de tablet. Alles staat standaard uit. | visitors:write |
| GET/visitor-analytics | Totalen per dag, uur, type en gastheer, plus de gemiddelde verblijfsduur over het afgelopen jaar. | visitors:read |
| GET/visitor-registration | Haal de zelfregistratielink van de locatie op en of die is ingeschakeld. | visitors:read |
| GET/school/movements | Te late aankomsten en vroeg vertrek van leerlingen, de oudste eerst, vanaf since (standaard de laatste 24 uur), met de reference van elke leerling voor het schoolinformatiesysteem. Een teamlid met alleen kijkrechten dat in X-Acting-User wordt genoemd, kan dit niet gebruiken. | school:read |
| PUT/school/pupils | Voeg tot 500 leerlingen toe of werk ze bij via reference; stuur active false voor een leerling die is vertrokken. Hier wordt niets verwijderd. | school:write |
De gegevens van bezoekers zijn persoonsgegevens: bewaar ze alleen zolang je ze nodig hebt.
Personen
De personenlijst bevat de bewoners, medewerkers of studenten die je balie bedient. Parcels zoekt ontvangers erin, Visitors zoekt gastheren en Equipment stelt personen voor. Houd hem via de API gelijk met je HR-, studenten- of accommodatiesysteem.
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/people | De lijst, op naam. Filters: search (naam, e-mailadres, unit of referentie), updated_since. | people:read |
| GET/people/{id} | Eén persoon. | people:read |
| POST/people | Voeg iemand toe: name (verplicht), email, unit, reference en language voor hun e-mails. | people:write |
| POST/people/upsert | Voeg tot 500 mensen toe of werk ze bij in één aanroep: people is een lijst met dezelfde velden. Iemand van wie het e-mailadres al op de lijst staat, wordt bijgewerkt. Antwoordt hoeveel er zijn toegevoegd, bijgewerkt en overgeslagen. | people:write |
| PATCH/people/{id} | Wijzig alleen de velden die je meestuurt. | people:write |
| DELETE/people/{id} | Verwijder iemand. Hun pakketten, bezoeken en uitgiftes behouden de naam die ze hadden. | people:write |
| GET/people/export | Download de volledige personenlijst als CSV die veilig is voor formules. | people:read |
| POST/people/{id}/send-my-vfound | Stuur één actieve persoon per e-mail de ondertekende pagina voor hun gekoppelde pakketten, bezoekers en apparatuur. | people:write |
| GET/people/sync-source | Toon de opgeslagen CSV-directory en het laatste synchronisatieresultaat. | people:read |
| PUT/people/sync-source | Sla een openbare HTTPS-CSV-url en mode (upsert of mirror) op. | people:write |
| DELETE/people/sync-source | Verwijder de koppeling en behoud de mensen die al zijn geïmporteerd. | people:write |
| POST/people/sync-source/run | Voer de opgeslagen koppeling nu uit. | people:write |
Eigenaren en managers kunnen ook een openbare HTTPS-CSV-link koppelen via Personen. vFound controleert hem elk uur, volgt hoogstens drie omleidingen nadat elke bestemming is gecontroleerd, accepteert hoogstens 10 MB en stopt in mirror-modus voordat het wijzigingen doorvoert wanneer het aantal geldige rijen met meer dan 30 procent daalt. Gekoppelde velden worden bij hun bron gewijzigd.
Automatische inrichting vanuit een directory
Microsoft Entra heeft de hierboven beschreven kant-en-klare koppeling die de klant zelf instelt. Identiteitsdirectory's, waaronder Okta, OneLogin en JumpCloud, kunnen in plaats daarvan de personenlijst inrichten op https://vfound.io/api/scim/v2/Users met een vFound API-sleutel die people:write heeft. Gebruik de Bearer-sleutel als het geheime token. Deactiveren haalt de persoon uit de suggesties; DELETE anonimiseert koppelingen volgens dezelfde regels voor Personen. Dit endpoint maakt alleen items in de personenlijst aan en nooit teamlogins.
Trainingsregisters voor Equipment kunnen uit dezelfde directory komen: koppel een training via de naam aan een directorygroep (Equipment, Beleid, Training) en wijs die groep dan toe aan de vFound-applicatie. https://vfound.io/api/scim/v2/Groups antwoordt alleen voor groepen die een training noemt en weigert elke andere groep. De leden zijn de mensen (via hun SCIM-gebruikers-id) die de training hebben; een persoon die de groep verlaat, verliest de training alleen als de directory die heeft gegeven, dus een dossier dat medewerkers hebben toegevoegd blijft. Een dossier dat de directory heeft gegeven en dat is verlopen, wordt vanaf die dag verlengd wanneer de directory de groep opnieuw stuurt met de persoon er nog in. Groepen antwoorden alleen voor een locatie met Equipment. Omdat groepslidmaatschap een training geeft, en een training mensen de apparatuur laat meenemen waarvoor die nodig is, kan een sleutel met people:write op deze manier trainingen toekennen: houd die sleutel voor je identiteitsprovider.
Webhooks
Voeg tot 25 HTTPS-adressen toe onder Instellingen, Voor ontwikkelaars, of via de API hieronder, en kies welke van de onderstaande gebeurtenissen elk adres ontvangt. vFound stuurt binnen enkele seconden een JSON-POST, probeert mislukte leveringen ongeveer drie uur opnieuw en pauzeert een adres na 15 mislukte leveringen achter elkaar.
| Gebeurtenis | Wanneer | Gegevens |
|---|---|---|
item.created | Er wordt een gevonden voorwerp toegevoegd | Voorwerp |
item.updated | De status, titel, plek, categorie, bewaardatum of zichtbaarheid van de foto verandert | Voorwerp |
item.transfer_sent | Een gevonden voorwerp wordt naar een andere locatie van de groep gestuurd (beide locaties ontvangen dit) | Verplaatsing van voorwerp |
item.transfer_cancelled | De verzendende locatie neemt het terug voordat het aankomt | Verplaatsing van voorwerp |
item.transfer_received | De ontvangende locatie bevestigt dat het is aangekomen | Verplaatsing van voorwerp |
claim.created | Een gast dient een claim in | Claim |
item.disposition_recorded | Een voorwerp wordt geschonken of afgevoerd | Voorwerp |
item.match_updated | Een opgeslagen AI-oordeel over een match verandert; report_id, item_id, label en reason | Matchpaar |
lost_report.match_updated | Een opgeslagen AI-oordeel over een match verandert; report_id, item_id, label en reason | Matchpaar |
claim.ownership_reviewed | Een manager legt een beoordeling van eigendom vast; haal de bewaargeschiedenis op voor de geschiedenis van de beoordeling | Claim |
claim.decision_recorded | Een claim wordt geaccepteerd of afgewezen | Claim |
claim.release_approved | Een andere manager keurt de vrijgave goed | Claim |
claim.handover_recorded | Het fysiek ophalen sluit een claim af die klaarstaat om opgehaald te worden | Claim |
claim.status_changed | Een claim gaat naar een nieuwe status | Claim |
lost_report.updated, lost_report.closed, lost_report.contact_updated, lost_report.created | Een gast meldt een verlies | Verliesmelding |
parcel.logged | Een pakket wordt aan de balie of via de API geregistreerd | Pakket |
parcel.updated | Een van de gegevens ervan verandert aan de balie, zoals de ontvanger, het trackingnummer of de plank | Pakket |
parcel.reminded | De ontvanger krijgt een herinnering, van de balie of automatisch | Pakket |
parcel.collected | Een pakket wordt overhandigd | Pakket |
parcel.returned | Een pakket gaat terug naar de afzender | Pakket |
parcel.recipient_arrived | Een ontvanger zegt dat hij bij de balie is | Regel in de ophaalwachtrij |
parcel.reminders_snoozed | Een ontvanger pauzeert zijn herinneringen | Persoon en aantal pakketten |
parcel.held | Een ontvanger stelt een datum voor het vasthouden in | Persoon, datum en aantal pakketten |
parcel.proxy_created | Een ontvanger mailt een gemachtigde een ophaalcode | Persoon, gemachtigde en vervaldatum |
parcel.pickup_served | De balie markeert een aankomst als geholpen | Regel in de ophaalwachtrij |
parcel.escalated | Een wachtend pakket bereikt de escalatieleeftijd van de locatie | Pakket |
parcel.outgoing_logged | Een uitgaand pakket wordt geregistreerd | Uitgaand pakket |
parcel.outgoing_handed_over | Een uitgaand pakket wordt aan een koerier overgedragen | Overdracht van uitgaand pakket |
parcel.round_created | Een bezorgronde wordt aangemaakt | Samenvatting van de ronde |
parcel.round_delivered | Een stop van een bezorgronde is afgerond | Id's van ronde, stop en pakket |
checkroom.checked_in | Er wordt iets ingecheckt en van een nummer voorzien | Ticket |
checkroom.handed_back | Het wordt teruggegeven | Ticket |
checkroom.left | De avond wordt gesloten terwijl het nog bij de checkroom ligt | Ticket |
checkroom.self_checkin_started | Een gast start een ticket via een gekoppelde kiosk | Ticket |
checkroom.ready_requested | Een gast vraagt de balie zijn spullen klaar te zetten | Ticket |
checkroom.ready | De balie markeert de spullen van een gast als klaar | Ticket |
checkroom.station_created | Er wordt een checkroompost aangemaakt | Post |
checkroom.station_updated | Een checkroompost verandert | Post |
checkroom.event_created | Er wordt een checkroomevenement aangemaakt | Gebeurtenis |
checkroom.event_updated | Een checkroomevenement verandert | Gebeurtenis |
loan.checked_out | Er wordt een artikel uitgegeven | Uitgifte |
loan.due_soon | De inlevertijd is minder dan twee uur weg, één keer per inlevertijd | Uitgifte |
loan.overdue | De inlevertijd verstrijkt en het is niet terug, één keer per inlevertijd | Uitgifte |
loan.extended | De inlevertijd verandert | Uitgifte |
loan.returned | Het komt terug bij de balie | Uitgifte |
loan.lost | Het wordt vastgelegd als niet terugkomend | Uitgifte |
loan.checkout_created | Er wordt één atomaire uitgifte van meerdere artikelen aangemaakt | Uitgifte, met eventuele voorraad op dezelfde bon in stock |
loan.self_checkout | Een persoon rondt de uitgifte aan de kiosk af | Uitgifte |
loan.kit_created | Er wordt een opgeslagen set apparatuur aangemaakt | Set |
loan.kit_updated | Een opgeslagen set apparatuur verandert | Set |
loan.reservation_requested | Een reservering wacht op goedkeuring | Reservering |
loan.reservation_created | Een reservering wordt direct bevestigd | Reservering |
loan.reservation_approved | Een reservering in behandeling wordt goedgekeurd | Reservering |
loan.reservation_ready | Gereserveerde apparatuur staat klaar om opgehaald te worden | Reservering |
loan.reservation_cancelled | Een reservering wordt geannuleerd | Reservering |
loan.reservation_collected | Gereserveerde apparatuur wordt meegegeven | Uitgifte |
loan.extension_requested | Iemand vraagt om meer tijd | Uitgifte |
loan.problem_reported | Iemand meldt een probleem met apparatuur | Uitgifte |
loan.rule_updated | Een uitgifteregel voor een categorie verandert | Regel |
loan.maintenance_logged | Er wordt onderhoud vastgelegd | Onderhoud |
loan.maintenance_due | Gepland onderhoud is aan de beurt | Onderhoud |
loan.service_due | Een terugkerend serviceschema is aan de beurt (op datum, aantal uren uitgegeven of aantal uitgiftes), één keer per ronde | Onderhoud |
loan.work_order_opened | Er wordt een werkopdracht geopend, door medewerkers of door een terugkeer waarvoor de locatie vraagt er een te openen | Onderhoud |
loan.work_order_closed | Een werkopdracht is afgerond of geannuleerd | Onderhoud |
loan.item_disposed | Een artikel wordt afgestoten (verkocht, afgevoerd, geschonken, gerecycled, verloren of gestolen) | Equipment |
loan.stocktake_started | Een inventarisatie van apparatuur start | Inventarisatie |
loan.stocktake_completed | Een inventarisatie van apparatuur eindigt | Inventarisatie |
loan.transfer_prepared | Een bevoegde locatie maakt apparatuur klaar om te verplaatsen | Verplaatsing |
loan.transfer_sent | Klaargemaakte apparatuur verlaat zijn bronlocatie | Verplaatsing |
loan.transfer_received | De bestemming ontvangt de apparatuur | Verplaatsing |
loan.transfer_rejected | De bestemming wijst een klaargemaakte verplaatsing af | Verplaatsing |
loan.transfer_cancelled | De bron annuleert een klaargemaakte verplaatsing | Verplaatsing |
loan.transfer_exception | Een verplaatsing onderweg heeft aandacht nodig | Verplaatsing |
loan.transfer_lost | De bron sluit een verplaatsing af die nooit is aangekomen | Verplaatsing |
loan.charge_recorded | Er wordt een boete, schade, vervanging, gebruik of andere vergoeding vastgelegd | Kostenregel |
loan.charge_waived | Een manager scheldt af wat een bedrag nog nodig heeft, met een reden | Kostenregel |
loan.payment_recorded | Medewerkers leggen geld vast dat de locatie zelf heeft ontvangen (vFound verwerkt nooit een betaling) | Kostenregel |
loan.payment_voided | Een manager maakt een per ongeluk vastgelegde betaling ongeldig | Kostenregel |
loan.deposit_recorded | Medewerkers leggen een borg vast die de locatie heeft ontvangen | Kostenregel |
loan.deposit_resolved | Een vastgehouden borg wordt teruggegeven of ingehouden | Kostenregel |
loan.invoice_issued | Er wordt een factuur uitgegeven voor de bedragen van een persoon | Factuur |
loan.invoice_voided | Een manager maakt een factuur ongeldig, met een reden | Factuur |
loan.quote_accepted | Het team accepteert een offerte en de bijbehorende boekingen worden gemaakt | Offerte |
loan.payment_request_created | Het team legt een betalingsverzoek vast (er wordt niets naar de persoon gestuurd) | Betalingsverzoek |
loan.payment_request_paid | Betalingen die bij een verzoek zijn vastgelegd, dekken het volledig | Betalingsverzoek |
loan.delivery_done | Een bezorging of een ophaalmoment is als gedaan gemarkeerd | Bezorging |
loan.items_imported | Een CSV-import van apparatuur is voltooid | Aantallen |
visit.expected | Een bezoeker wordt uitgenodigd | Bezoek |
visit.signed_in | Een bezoeker meldt zich aan, aan de balie of via je QR-bord | Bezoek |
visit.host_confirmed | De balie bevestigt wie een bezoeker die zichzelf aanmeldde kwam bezoeken | Bezoek |
visit.signed_out | Ze melden zich af, aan de balie, met hun pas of automatisch nadat de dag is afgelopen | Bezoek |
visit.cancelled | Een uitnodiging wordt geannuleerd | Bezoek |
visit.approval_requested | Een bezoek wacht op goedkeuring door medewerkers | Bezoek |
visit.approved | Een bezoek in behandeling wordt goedgekeurd | Bezoek |
visit.denied | Een bezoek in behandeling wordt afgewezen | Bezoek |
visit.host_replied | Een gastheer antwoordt via zijn privélink | Bezoek |
visit.roll_call_started | Een live appèl (een noodgeval, een oefening of een mededeling) start | Samenvatting van het appèl |
visit.roll_call_completed | Een live appèl eindigt | Samenvatting van het appèl |
visitor_type.created | Er wordt een bezoekerstype aangemaakt | Bezoekerstype |
visitor_type.updated | Een bezoekerstype verandert | Bezoekerstype |
visitor_type.deactivated | Een bezoekerstype wordt gedeactiveerd | Bezoekerstype |
visitor_agreement.signed | Een bezoeker heeft een overeenkomst ondertekend, met een link naar het ondertekende exemplaar die zeven dagen werkt | Ondertekening van overeenkomst |
kiosk.paired | Een bezoekerskiosk wordt gekoppeld | Kiosk |
kiosk.revoked | Een bezoekerskiosk wordt ingetrokken | Kiosk |
courier.signed_in | Een bezoeker die iets bezorgt, wordt geregistreerd in Parcels | Koerier |
courier.signed_out | Een bezoeker die iets bezorgt, vertrekt | Koerier |
staff.signed_in | Een persoon op de medewerkerslijst meldt zich aan, op kantoor of op afstand | Aanwezigheid van medewerkers |
staff.signed_out | Een persoon op de medewerkerslijst meldt zich af, of wordt automatisch afgemeld | Aanwezigheid van medewerkers |
person.created | Er wordt een persoon toegevoegd | Persoon |
person.updated | Een persoon wordt gewijzigd | Persoon |
person.deactivated | Inrichting vanuit een directory deactiveert een persoon | Persoon |
person.deleted | Een persoon wordt verwijderd | Persoon |
people.sync.completed | Een gekoppelde CSV-synchronisatie is voltooid | Aantallen |
people.sync.failed | Een gekoppelde CSV-synchronisatie mislukt veilig | Fout |
report.delivered | Een geplande rapportage uit Rapporten en analyses, gedeeld met de locatie, wordt uitgevoerd met levering aan gekozen webhooks (een privérapport wordt nooit naar webhooks gestuurd); meld je erop aan in Instellingen, Voor ontwikkelaars (een API-sleutel kan zich er niet op aanmelden) | Elke kolom die het rapport noemt en tot 5,000 rijen, of elke groep |
queue.ticket_joined | Een persoon sluit aan in een rij, vanaf zijn telefoon, een kiosk, de balie of de API | Queue-ticket |
queue.ticket_called | Een persoon wordt naar een balie geroepen, of opnieuw geroepen | Queue-ticket |
queue.ticket_served | Een persoon wordt als geholpen gemarkeerd | Queue-ticket |
queue.ticket_no_show | Een opgeroepen persoon wordt als no-show gemarkeerd, door het team of na de minuten van de rij | Queue-ticket |
queue.ticket_left | Een persoon verlaat de rij vanaf zijn ticket, of het team haalt hem eruit | Queue-ticket |
queue.ticket_transferred | Een persoon wordt naar een andere rij of balie verplaatst | Queue-ticket |
queue.ticket_closed | Een ticket dat aan het einde van de dag van de locatie nog open is, of in een gearchiveerde rij, wordt gesloten | Queue-ticket |
queue.booking_created | Een persoon reserveert een tijd op de pagina met gereserveerde tijden van een rij, of de API doet dat | Queue-reservering |
queue.booking_cancelled | Een gereserveerde tijd wordt geannuleerd door de persoon, het team of de API | Queue-reservering |
queue.ticket_arrived | Een persoon die aansloot voordat hij er was, zegt dat hij er is, of het team markeert hem als aangekomen | Queue-ticket |
queue.message_received | Een persoon in de rij schrijft het team vanaf zijn ticketpagina; de gebeurtenis bevat geen tekst | Queue-bericht |
queue.message_sent | Het team schrijft een persoon in de rij; de gebeurtenis bevat geen tekst | Queue-bericht |
queue.survey_answered | Een geholpen persoon beantwoordt de enquête; de gebeurtenis bevat de beoordeling en nooit de opmerking | Antwoord op de Queue-enquête |
{"id":"evt_…","type":"claim.created","created":"2026-09-23T14:30:00+00:00",
"venue":{"code":"harbourhotel","name":"Harbour Hotel"},"data":{ …the claim… }}
Controleer de handtekening
Elke levering bevat Vfound-Signature: t=<unix time>,v1=<hex>, waarbij de hex een HMAC SHA256 is van t + "." + raw body met het geheim van je endpoint. Weiger leveringen die ouder zijn dan vijf minuten. Nadat je een nieuw ondertekeningsgeheim hebt gemaakt, bevatten leveringen 24 uur lang twee v1-waarden, één voor elk geheim, dus accepteer de levering als een van beide klopt.
// Node.js
const crypto = require("crypto");
function verified(rawBody, header, secret) {
const parts = header.split(",").map((p) => p.split("="));
const t = (parts.find(([k]) => k === "t") || [])[1];
const expected = crypto.createHmac("sha256", secret).update(t + "." + rawBody).digest("hex");
const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;
return fresh && parts.some(([k, v]) => k === "v1" && v.length === expected.length
&& crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(v)));
}
// PHP
$t = null; $signatures = [];
foreach (explode(',', $header) as $part) {
[$k, $v] = array_pad(explode('=', $part, 2), 2, '');
if ($k === 't') { $t = $v; } elseif ($k === 'v1') { $signatures[] = $v; }
}
$expected = hash_hmac('sha256', $t.'.'.$rawBody, $secret);
$ok = abs(time() - (int) $t) < 300
&& count(array_filter($signatures, fn ($s) => hash_equals($expected, $s))) > 0;
De headers bevatten ook Vfound-Event en een unieke Vfound-Delivery-id die je kunt gebruiken om herhalingen te negeren. Webhooks worden alleen naar openbare HTTPS-adressen op poort 443 gestuurd.
Aanmelden via de API
Tools zoals Zapier kunnen hun eigen adressen toevoegen en verwijderen met een sleutel die webhooks:manage heeft. Het ondertekeningsgeheim wordt één keer getoond, in het antwoord op de POST. Het antwoord bevat ook een Location-header met het adres dat je met DELETE aanroept wanneer het abonnement wordt verwijderd.
Een sleutel kan zich alleen aanmelden voor gebeurtenissen waarvan hij de gegevens kan lezen: elke gebeurtenis vraagt om de leesscope van het product ervan (items:read voor gebeurtenissen over voorwerpen, claims:read voor gebeurtenissen over claims, lost_reports:read, parcels:read, checkroom:read, loans:read voor gebeurtenissen over apparatuur, visitors:read voor gebeurtenissen over bezoeken, bezoekerstypen, kiosken en koeriers, en people:read voor gebeurtenissen over personen en de personenlijst). Een sleutel toont en verwijdert alleen de adressen die hij zelf heeft aangemaakt; adressen die in Instellingen of door een andere sleutel zijn toegevoegd, ziet hij niet.
| Verzoek | Wat het doet | Scope |
|---|---|---|
| GET/webhooks | De adressen die deze sleutel heeft aangemaakt, en hun gebeurtenissen. | webhooks:manage |
| POST/webhooks | Voeg een adres toe: url (openbaar HTTPS op poort 443) en events, een lijst met gebeurtenissen hierboven die de sleutel kan lezen. | webhooks:manage |
| DELETE/webhooks/{id} | Verwijder een adres dat deze sleutel heeft aangemaakt, en zijn leveringsgeschiedenis. | webhooks:manage |
Leveringsgeschiedenis
Instellingen, Voor ontwikkelaars, toont elke levering aan elk adres van de laatste 30 dagen, met hoe het ging, en stuurt elk ervan opnieuw met dezelfde Vfound-Delivery-id. Daar kun je ook een adres bewerken, een gepauzeerd adres weer inschakelen en een nieuw ondertekeningsgeheim maken. Een adres dat 15 leveringen achter elkaar mislukt, wordt gepauzeerd en de eigenaar van de locatie krijgt een e-mail.
Rapportgegevensfeed (Power BI)
Een eigenaar of manager maakt een feedlink in Rapporten en analyses, onder Power BI-datafeed, voor de producten die hij kiest. De link wordt één keer getoond. Kies in Power BI Get data, dan Web, en plak hem. Elke link leest één locatie en stopt direct wanneer hij wordt ingetrokken, wanneer de persoon die hem maakte geen eigenaar of manager van de locatie meer is, of wanneer de locatie is gepauzeerd of gesloten.
GET /api/feeds/reports/{token}/{dataset} antwoordt met de rijen van één dataset: equipment_loans, equipment_activity, visits of checkroom_tickets. Kies de periode met days (1 tot 366, 90 als je het weglaat) of from en to (YYYY-MM-DD, op de klok van de locatie). GET /api/feeds/reports/{token}/saved/{id} antwoordt met een opgeslagen rapport dat met de hele locatie wordt gedeeld, voor de eigen periode van dat rapport; days, from en to veranderen dat niet. Je kunt het token ook sturen als Authorization: Bearer <token> naar /api/feeds/reports/{dataset} of /api/feeds/reports/saved/{id}. Eén antwoord bevat tot 100,000 rijen in value, dus Get data, Web leest het hele resultaat; zet de lijst value daarna om in een tabel. Het antwoord eindigt met total en truncated: wanneer meer rijen overeenkomen dan één antwoord bevat, is truncated true en noemt @odata.nextLink de rest ($top en $skip bladeren erdoor, voor tools die hem volgen); Get data, Web volgt hem niet, dus kies in dat geval een kortere periode. Wanneer de rijen van een rapport meer dan 400,000 gelezen rijen of meer dan 20 seconden zouden vragen, eindigt het antwoord met error, total null en truncated true; een opgeslagen rapport met groepering antwoordt in plaats daarvan 422 met de reden. Rijen komen in de volgorde waarin ze zijn vastgelegd. Tijden in rijen zijn UTC (ISO 8601); een opgeslagen rapport dat op een datum is gegroepeerd, labelt elke groep met de dag, week, maand, weekdag of het uur op de klok van de locatie. E-mailadressen en de naam en kamer van een gast van de checkroom worden weggelaten, tenzij de link is gemaakt om contactgegevens op te nemen.
AI-assistenten (MCP)
vFound is een Model Context Protocol-server op https://vfound.io/api/mcp, zodat AI-assistenten dingen kunnen opzoeken en aan de balie kunnen helpen. Koppel er een op een van twee manieren: inloggen met vFound, voor assistenten waarvan de connectors inloggen met OAuth, of een API-sleutel, voor clients die een header sturen, zoals Claude Code, Cursor en Visual Studio Code. Hoe dan ook ziet hij alleen de tools die zijn scopes toestaan, voor de producten die je locatie heeft geopend. Een client die met een API-sleutel is gekoppeld, mag ook X-Acting-User sturen; elke tool wordt dan uitgevoerd als dat teamlid, binnen zijn rol.
# Claude Code
claude mcp add --transport http vfound https://vfound.io/api/mcp \
--header "Authorization: Bearer $VFOUND_KEY"
// Cursor (.cursor/mcp.json)
{"mcpServers":{"vfound":{"url":"https://vfound.io/api/mcp","headers":{"Authorization":"Bearer vf_live_…"}}}}
// Visual Studio Code (.vscode/mcp.json)
{"servers":{"vfound":{"type":"http","url":"https://vfound.io/api/mcp","headers":{"Authorization":"Bearer vf_live_…"}}}}
| Tool | Wat het doet | Scope |
|---|---|---|
search_found_items | Zoek gevonden voorwerpen op woorden zoals “zwarte iPhone” | items:read |
list_expected_visitors | Bezoekers die zijn uitgenodigd en er nog niet zijn | visitors:read |
list_visitors_on_site | Bezoekers die nu zijn aangemeld | visitors:read |
list_visitor_types | Bezoekerstypen en hun regels | visitors:read |
visitor_analytics | Totalen, patronen en gemiddelde verblijfsduur van bezoekers | visitors:read |
visitor_registration_link | De zelfregistratielink van de locatie | visitors:read |
list_couriers_on_site | Koeriers die via Visitors zijn aangemeld | parcels:read |
list_waiting_parcels | Pakketten die wachten om opgehaald te worden | parcels:read |
detect_parcel_tracking | Normaliseer een trackingnummer en herken de vervoerder | parcels:read |
parcel_pickup_queue | Mensen die wachten bij de pakketbalie | parcels:read |
parcel_shelves | Capaciteit en bezetting van de pakketplanken | parcels:read |
parcel_analytics | Pakketvolume, vervoerders en prestaties bij het ophalen | parcels:read |
list_outgoing_parcels | Uitgaande pakketten en hun overdrachtsstatus | parcels:read |
list_parcel_rounds | Bezorgrondes en stops van pakketten | parcels:read |
list_checkroom_exit_queue | Tickets waarvan de gasten bij de uitgang wachten | checkroom:read |
mark_checkroom_ready | Markeer een wachtend ticket als klaar en breng de gast op de hoogte | checkroom:write |
list_checkroom_stations | Checkroomposten en nummerreeksen | checkroom:read |
list_checkroom_events | Recente en aankomende checkroomevenementen | checkroom:read |
checkroom_report | Checkroomvolume, teruggavetijd en totalen van kosten | checkroom:read |
list_queue_lines | Rijen, mensen die wachten en de geschatte wachttijd nu | queue:read |
list_queue_waiting | Mensen die vandaag wachten, in de volgorde van oproepen | queue:read |
queue_report | Queue-totalen en mediane wacht- en servicetijd in minuten | queue:read |
call_next_in_queue | Roep de volgende persoon op naar een balie | queue:write |
mark_queue_ticket_served | Markeer de persoon bij een balie als geholpen | queue:write |
list_overdue_equipment | Apparatuur die te laat is, en wie het heeft | loans:read |
list_equipment_kits | Opgeslagen groepen apparatuur | loans:read |
create_equipment_kit | Sla een herbruikbare set apparatuur op zonder die uit te geven | loans:write |
list_equipment_reservations | Reserveringen op tijd en status | loans:read |
reserve_equipment | Reserveer een artikel of categorie zonder het uit te geven | loans:write |
book_repeating_reservation | Boek een artikel, categorie of ruimte elke dag of week | loans:write |
move_reservation | Verplaats een reservering naar nieuwe tijden of een ander artikel van de categorie | loans:write |
list_waitlist | De mensen die wachten op een tijd die al bezet was | loans:read |
join_waitlist | Zet iemand op de wachtlijst | loans:write |
list_space_bookings | Elke kamer, werkplek of parkeerplaats en de boekingen ervan tussen twee tijden | loans:read |
book_space | Boek een kamer of ruimte voor een persoon en tijd; die wordt nooit uitgegeven | loans:write |
list_equipment_rules | Uitgifteregels van de locatie en per categorie | loans:read |
save_equipment_rule | Maak een categorieregel aan of vervang hem | loans:write |
list_equipment_maintenance | Onderhoudsgeschiedenis van apparatuur en aankomend werk | loans:read |
list_equipment_service_plans | Terugkerende schema's voor service, kalibratie, veiligheidstest, inspectie en schoonmaak en welke aan de beurt zijn | loans:read |
update_equipment_work_order | Wijzig of sluit een werkopdracht voor apparatuur | loans:write |
get_equipment_maintenance_costs | Kosten van service, reparatie en schoonmaak per artikel | loans:read |
get_equipment_valuation | De waarde van de apparatuur op een datum na afschrijving (eigenaren en managers) | loans:read |
list_equipment_substances | Het register van gevaarlijke stoffen: stof, plek, gevarenklassen en data van beoordeling (een registratie, geen veiligheidsadvies) | loans:read |
get_equipment_funding | Wat elk fonds, elke subsidie of kostenplaats heeft gekocht en welk werk eraan is toegerekend (eigenaren en managers) | loans:read |
get_equipment_planner | Gepland werk en open werkopdrachten per eigen dag van de locatie | loans:read |
list_equipment_licences | Licenties voor de apparatuur met aantal gebruikers en einddata (eigenaren en managers) | loans:read |
get_equipment_expiries | Verzekeringen en licenties die binnenkort aflopen of al zijn afgelopen (eigenaren en managers) | loans:read |
log_equipment_maintenance | Leg service, kalibratie, een veiligheidstest, een inspectie, schoonmaak, een reparatie of een notitie vast | loans:write |
list_equipment_stocktakes | Recente inventarisaties en hun tellingen | loans:read |
start_equipment_stocktake | Start een inventarisatie | loans:write |
scan_equipment_stocktake | Leg één artikel vast in een open inventarisatie | loans:write |
scan_many_equipment_stocktake | Tel veel codes tegelijk in een open inventarisatie | loans:write |
finish_equipment_stocktake | Rond een inventarisatie af en geef terug wat ontbreekt | loans:write |
list_equipment_transfers | Binnenkomende en uitgaande verplaatsingen zonder gegevens van personen | loans:read |
preview_equipment_import | Valideer een CSV van apparatuur zonder die op te slaan | loans:write |
find_person | Zoek iemand op in de personenlijst | people:read |
export_people | Exporteer de personenlijst als CSV die veilig is voor formules | people:read |
directory_sync_status | Controleer de opgeslagen CSV-koppeling en de laatste run ervan | people:read |
run_directory_sync | Voer de opgeslagen CSV-koppeling nu uit | people:write |
email_my_vfound | Stuur één persoon zijn ondertekende privépagina per e-mail | people:write |
invite_visitor | Nodig een bezoeker uit, die een pas per e-mail krijgt | visitors:write |
approve_visit | Keur een bezoekverzoek goed dat in behandeling is | visitors:write |
list_free_workplace_spaces | Zoek vrije werkplekken, vergaderruimtes of parkeerplaatsen voor een tijd | visitors:read |
book_workplace_space | Boek een werkplek, vergaderruimte of parkeerplaats voor een persoon | visitors:write |
request_visit_catering | Vraag catering aan bij een bezoek, uit de opties die de locatie opgeeft | visitors:write |
list_appointment_pages | Toon de afsprakenpagina's van de locatie en of elke openstaat voor bezoekers | visitors:read |
list_staff_on_site | Toon de mensen op de medewerkerslijst die nu zijn aangemeld, op kantoor of op afstand | visitors:read |
sign_staff_in_or_out | Meld een persoon op de medewerkerslijst aan of af | visitors:write |
list_visitor_assets_not_returned | Toon dingen die aan bezoekers zijn meegegeven en nog niet als teruggebracht zijn gemarkeerd | visitors:read |
issue_visitor_asset | Leg een ding vast dat aan een verwacht of aangemeld bezoek is meegegeven | visitors:write |
return_visitor_asset | Markeer een ding dat aan een bezoek is meegegeven als teruggebracht | visitors:write |
start_roll_call | Start een appèl of geef het actieve appèl terug | visitors:write |
mark_visitor_safe | Markeer één bezoeker als veilig | visitors:write |
create_kiosk_pairing | Maak een koppelcode voor een kiosk van tien minuten aan | visitors:write |
log_parcel | Registreer een pakket en stuur de ontvanger een e-mail | parcels:write |
remind_parcel | Herinner een ontvanger eraan een pakket op te halen | parcels:write |
remind_parcels | Herinner tot 200 geselecteerde ontvangers van pakketten | parcels:write |
log_outgoing_parcel | Voeg een uitgaand pakket toe aan het koerierslogboek | parcels:write |
create_parcel_round | Maak een bezorgronde van wachtende pakketten | parcels:write |
extend_loan | Geef een persoon meer tijd | loans:write |
Elke tool voert het API-verzoek hierboven uit met dezelfde controles, dus een assistent kan nooit meer doen dan zijn sleutel of verbinding. Er zijn geen tools die iets overhandigen, iemand aan- of afmelden, over een claim beslissen of verwijderen. Elk antwoord telt mee voor de 120 verzoeken per minuut van de sleutel of verbinding.
Inloggen met vFound
Voeg https://vfound.io/api/mcp toe als connector in je eigen assistent. De assistent vindt zelf hoe hij moet inloggen en opent een vFound-pagina, waar een eigenaar of manager zoals gewoonlijk inlogt in zijn werkruimte, de locatie kiest en in gewone woorden ziet wat de assistent mag doen, en alles kan uitvinken. Medewerkers en leden met alleen kijkrechten kunnen geen assistent koppelen. De assistent is van je eigen locatie: je abonnement bij de aanbieder ervan betaalt voor de AI, en vFound ontvangt alleen de toolverzoeken die hij stuurt.
Een verbinding handelt als de persoon die haar heeft toegestaan, met dezelfde controles als een API-sleutel: ze stopt met werken als die persoon de locatie niet meer beheert of de locatie niet actief is, ze wijzigt niets zolang het abonnement is gepauzeerd, en ze ziet alleen tools voor geopende producten. Het toegangstoken is een uur geldig en de assistent vernieuwt het zelf; een verbinding die 30 dagen niet is gebruikt, logt opnieuw in. Bekijk elke verbinding, wie haar koppelde en wanneer ze voor het laatst is gebruikt in Instellingen, Voor ontwikkelaars, waar Ontkoppelen haar direct stopt. Het token werkt alleen op het MCP-endpoint, niet op de REST API; een app die de REST API nodig heeft, koppelt zoals het volgende gedeelte zegt.
Voor ontwikkelaars van clients: OAuth 2.1 zoals de MCP-autorisatiespecificatie het beschrijft, alleen met de authorization code flow en PKCE (S256). Discovery: /.well-known/oauth-protected-resource (RFC 9728, resource https://vfound.io/api/mcp) en /.well-known/oauth-authorization-server (RFC 8414); een verzoek zonder token krijgt een WWW-Authenticate-header die de eerste noemt. Clients registreren zichzelf op /oauth/register (RFC 7591) als openbare clients zonder geheim; redirectadressen moeten https gebruiken, of http alleen voor localhost of 127.0.0.1, en moeten dan exact overeenkomen. Daarna /oauth/authorize, /oauth/token (codes zijn 60 seconden geldig en werken één keer; refresh-tokens worden bij elk gebruik vervangen, en een oud token opnieuw gebruiken verbreekt de verbinding met de assistent) en /oauth/revoke (RFC 7009). Scopes gebruiken de namen van de API-sleutels hierboven; stuur resource=https://vfound.io/api/mcp mee (RFC 8707).
Inloggen met vFound voor andere apps
Een app die geen AI-assistent is, zoals een voorraad-, boekings- of HR-systeem, kan op dezelfde manier met de REST API verbinden in plaats van met een API-sleutel: stuur resource=https://vfound.io/api/v1 naar /oauth/authorize en /oauth/token, met scopes in de namen van de API-sleutels, behalve webhooks:manage, die een app niet kan krijgen. Een eigenaar of manager logt in, ziet de naam van de app en in gewone woorden wat die mag doen, kan alles uitvinken en geeft toestemming. De verbinding handelt als die persoon met dezelfde controles als een API-sleutel: ze stopt met werken als die persoon de locatie niet meer beheert of de locatie niet actief is, ze wijzigt niets zolang het abonnement is gepauzeerd, en ze mag 120 verzoeken per minuut doen, net als een sleutel. X-Acting-User werkt alleen met een API-sleutel. Het toegangstoken werkt alleen op de REST API, nooit op het MCP-endpoint, en een toestemming die voor het ene is getoond, keurt het andere nooit goed. Ze staat vermeld in Instellingen, Voor ontwikkelaars als een app die de vFound API gebruikt, waar Ontkoppelen haar direct stopt. Discovery: /.well-known/oauth-protected-resource/api/v1; de rest is de flow hierboven.
Fouten
Fouten zijn JSON met een message; validatiefouten voegen errors per veld toe. 401 betekent geen geldige sleutel, 403 een ontbrekende scope, een sleutel waarvan de maker de locatie niet meer beheert, een teamlid in X-Acting-User dat geen actief lid is of wiens rol de scope niet toestaat, een locatie die niet actief is, of een wijziging die is gestuurd terwijl het abonnement is gepauzeerd, 404 niet gevonden op je locatie, 422 ongeldige invoer en 429 te veel verzoeken.
Wanneer een wijziging niet kan gebeuren vanwege de huidige status van het dossier, is het antwoord 422 met ook een vaste code. De codes veranderen nooit van naam:
| Code | Wat het betekent |
|---|---|
parcel_not_waiting | Het pakket wacht niet meer: het is al opgehaald, teruggestuurd of bezorgd. |
tracking_duplicate | Er wacht hier al een pakket met dit trackingnummer. |
no_email | De persoon of bezoeker heeft geen e-mailadres, dus er kan niets worden gestuurd. |
capacity_full | Elk checkroomnummer is in gebruik. |
already_checked_in | Het checkroomticket is al ingecheckt. |
already_handed_back | Het checkroomticket is al teruggegeven. |
nothing_to_hand_back | Het checkroomticket heeft niets om terug te geven. |
number_in_use | Dat checkroomnummer is al in gebruik. |
ticket_closed | Alleen een open checkroomticket kan per e-mail worden gestuurd. |
item_out | De apparatuur is uitgegeven aan iemand. Neem het eerst in. |
item_in_repair | De apparatuur is opzij gelegd voor reparatie. |
item_retired | De apparatuur is buiten gebruik, dus ze kan niet worden uitgegeven of gereserveerd. |
reservation_conflict | Iemand heeft het artikel, of het laatste vrije in zijn categorie, in deze tijd gereserveerd, of er wordt verwacht dat het nog is uitgegeven. |
already_back | De apparatuur is al ingenomen. |
not_out | De apparatuur is niet uitgegeven, dus ze kan niet meer tijd krijgen, geen herinnering krijgen en niet als niet-terugkomend worden gemarkeerd. |
borrower_overdue | De persoon heeft apparatuur die te laat is, en de locatie of de categorie staat niets meer toe totdat die terug is. |
borrower_item_limit | Hiermee zou de persoon meer artikelen krijgen dan de locatie of de categorie tegelijk toestaat. |
reservation_not_ready | De reservering is nog niet goedgekeurd, of is al opgehaald of geannuleerd. |
reservation_item_mismatch | De uitgifte bevat niet het artikel waarvoor de reservering is. |
reservation_category_mismatch | De uitgifte bevat een artikel buiten de gereserveerde categorie. |
reservation_borrower_mismatch | De reservering hoort bij een andere persoon. |
reservation_too_long | De reservering is langer dan de categorie kan worden meegenomen. Alleen reserveringen die via My vFound zijn gemaakt, hebben deze beperking. |
reservation_daily_limit | De persoon heeft de laatste 24 uur al 5 reserveringen via My vFound gemaakt. |
booking_notice | De reservering begint eerder dan de minimale vooraankondiging van de categorie toestaat. |
booking_too_far_ahead | De boeking, uitgifte of nieuwe inlevertijd eindigt later dan de categorie vooruit kan worden geboekt. |
desk_closed | De reservering zou beginnen op een dag waarop de balie voor apparatuur gesloten is. |
kit_unavailable | Een deel van een set of winkelwagen is voor deze tijd niet beschikbaar, dus er is niets gereserveerd. Het veld unavailable toont elk deel en waarom. |
borrower_not_in_group | De locatie laat alleen mensen met een persoonstype meenemen of boeken, en deze persoon heeft er geen (of is getypt in plaats van gekozen uit de personenlijst). |
category_not_allowed | Geen van de persoonstypen van deze persoon staat deze categorie toe. |
borrower_on_hold | Meenemen is gepauzeerd voor deze persoon: medewerkers hebben een blokkade geplaatst, de locatie pauzeert het meenemen na herhaald te laat terugbrengen, of de persoon is minstens het bedrag verschuldigd waarbij de locatie blokkeert (kind charges). Het veld hold geeft de soort en tot wanneer. |
space_too_small | Meer mensen dan de kamer of ruimte kan bevatten (de capaciteit ervan). |
kit_locked | De apparatuur hoort bij een vergrendelde set, die alleen als geheel wordt uitgegeven: neem elk benoemd artikel van de set mee. |
approval_not_yours | De locatie heeft goedkeurders in volgorde ingesteld en deze persoon is niet de volgende (of de locatie laat niemand een stap voor hem overslaan). |
project_not_approved | De boeking hoort bij een project dat nog niet is goedgekeurd, dus er kan niets worden opgehaald. |
not_enough_credits | De locatie gebruikt boekingstegoeden en deze persoon heeft er geen meer. Geef er eerst wat. Een boeking die wordt geannuleerd of nooit wordt opgehaald, geeft het tegoed terug. |
risk_assessment_pending | De boeking heeft een risicobeoordeling die niet is goedgekeurd, dus er kan niets worden opgehaald. |
series_unavailable | Een terugkerende boeking kon niet worden gemaakt omdat minstens één van de tijden bezet is of tegen een boekingsregel ingaat, dus er is niets gereserveerd. Het veld skipped toont elke tijd en waarom. |
time_available | De tijd waarop iemand wilde wachten is vrij, dus boek die in plaats van op de wachtlijst te komen. |
space_not_handed_out | Een kamer of ruimte wordt voor zijn tijd geboekt en nooit uitgegeven, dus ze kan niet worden uitgegeven of opgehaald. |
stock_short | Er is niet genoeg van dit voorraadartikel op de genoemde plek (en batch), dus er is niets veranderd. Het veld available geeft de hoeveelheid daar. |
stock_issue_closed | Alles van deze uitgifte van voorraad is al terug of afgeschreven. |
order_closed | Een inkooporder is afgerond of geannuleerd en kan niet meer veranderen. |
order_over_received | Er is meer ingevoerd dan een regel van een inkooporder nog verwacht. |
order_not_placed | Voorraad kan niet worden ontvangen tegen een inkooporder die nog een concept is. |
fees_off | Kosten staan uit voor deze locatie. Schakel ze eerst in bij Beleid voor de balie en het gebruik. |
entry_closed | Die kostenregel of factuur kan niet meer op deze manier veranderen: het bedrag is verrekend of kwijtgescholden, de betaling is ongeldig gemaakt, de borg is teruggegeven of ingehouden, of de factuur is ongeldig. |
on_invoice | Het bedrag staat op een uitgegeven factuur. Maak de factuur eerst ongeldig en scheld het bedrag dan kwijt. |
not_late | De uitgifte kwam niet te laat terug volgens de regels van de locatie voor boetes bij te laat, of is nog uitgegeven. |
nothing_to_invoice | De persoon heeft in die valuta geen openstaand bedrag dat nog niet op een uitgegeven factuur staat. |
charge_unavailable | Een van de gekozen bedragen staat niet open, staat op een andere factuur of is voor iemand anders. |
desk_kept | De werkplek wordt op een van de gevraagde dagen voor een andere persoon vrijgehouden. |
desk_has_bookings | De werkplek voor deze persoon vrijhouden zou botsen met open boekingen van anderen op die dagen. Annuleer die eerst. |
booking_closed | De boeking van de werkplek, kamer of parkeerplaats is geannuleerd of vrijgegeven, dus ze kan niet worden ingecheckt. |
check_in_closed | Inchecken opent 15 minuten voordat een boeking begint en sluit wanneer die eindigt. |
item_service_due | De locatie houdt apparatuur die onderhoud nodig heeft tegen om uitgegeven te worden, en de servicedatum van dit artikel is gekomen of een van zijn schema's is aan de beurt. Leg eerst het werk vast. |
item_failed_inspection | De locatie houdt apparatuur die onderhoud nodig heeft tegen om uitgegeven te worden, en de laatste controle van dit artikel is mislukt. Leg eerst een geslaagde controle vast. |
work_order_closed | Deze werkopdracht is al gesloten en kan niet meer worden gewijzigd. |
already_disposed | Dit artikel is al afgestoten. |
not_disposed | Dit artikel is niet afgestoten, dus er valt niets ongedaan te maken. |
item_disposed | Dit artikel is afgestoten. Maak de afstoting ongedaan voordat je het opnieuw gebruikt. |
training_required | Een categorieregel of het artikel vereist een training die de persoon niet heeft, of alleen heeft na de vervaldatum ervan. Het veld training noemt wat ontbreekt. |
stocktake_open | Er is al een inventarisatie open. Rond die eerst af. |
item_unavailable | De apparatuur is niet beschikbaar of opzij gelegd voor reparatie, dus ze kan geen verplaatsing starten. |
transfer_open | De apparatuur heeft al een open verplaatsing. |
transfer_not_ready | Alleen een klaargemaakte verplaatsing kan worden verzonden. |
transfer_not_in_transit | Alleen apparatuur die onderweg is, kan worden ontvangen of met een probleem worden gemarkeerd. |
transfer_already_sent | Een verzonden verplaatsing kan niet meer worden geannuleerd of afgewezen. |
already_signed_in | De bezoeker is al aangemeld. |
visit_closed | Het bezoek is gesloten. Meld de bezoeker aan als een nieuw bezoek. |
not_signed_in | De bezoeker is niet aangemeld. |
not_expected | Alleen een verwacht bezoek kan worden geannuleerd of een pas krijgen. |
approval_required | Het bezoek heeft goedkeuring nodig voordat de bezoeker zich kan aanmelden. |
visit_not_valid_today | De pas kan vandaag niet meer worden gebruikt, of vandaag valt buiten de data ervan. |
plus_one_not_allowed | De pas staat geen gasten toe, of is niet meer goedgekeurd, verwacht of geldig. |
plus_one_limit | De bezoeker heeft alle gasten toegevoegd die de pas toestaat. |
nobody_to_sign_in | Niemand in de groep van het bezoek wordt vandaag verwacht. |
visitor_capacity_full | Als de bezoeker zich aanmeldt, wordt de limiet van de locatie of van het bezoekerstype voor tegelijk aangemelde bezoekers overschreden. |
Een bezoeker aan de balie aanmelden antwoordt 409 met een code wanneer de bezoeker eerst door een teamlid moet worden gecontroleerd. Het antwoord noemt alleen de soort treffer (blocklist, building, restricted_party of answers); de regel, de naam en de reden ervan zijn voor het team van de locatie en staan nooit in een API-antwoord. Stuur het verzoek opnieuw met screening_reviewed op true pas nadat een teamlid de treffer heeft gecontroleerd. Daarvoor is een sleutel met de scope visitors:screening nodig (standaard uit, net als de toegang van elke andere sleutel ertoe), en een sleutel die een teamlid noemt in X-Acting-User heeft een teamlid nodig wiens rol over bezoeken beslist. De bevestiging wordt vastgelegd als die van de sleutel, met zijn naam, nooit als het teamlid dat de sleutel heeft aangemaakt. Zonder de scope is het antwoord 403 met screening_scope. Hetzelfde geldt voor het goedkeuren van een bezoek dat door een treffer wordt tegengehouden:
| Code | Wat het betekent |
|---|---|
screening_match | De bezoeker komt overeen met een van de blokkeerlijsten van de locatie, een controle door het team of de screeninglijst. Een teamlid moet bevestigen dat hij de treffer heeft gecontroleerd voordat de bezoeker wordt aangemeld. |
screening_scope | Het verzoek bevestigt of keurt een screeningtreffer goed, en de sleutel heeft de scope visitors:screening niet (of het teamlid dat in X-Acting-User wordt genoemd, beslist niet over bezoeken). |
Workflowchecklists
Een locatie met vFound Enterprise kan de stappen instellen die haar medewerkers bevestigen op een sleutelmoment: een gevonden voorwerp registreren, overhandigen, schenken of afvoeren; een pakket overhandigen of terugsturen; inchecken of teruggeven bij de checkroom; apparatuur uitgeven of innemen; en een bezoeker aan- of afmelden. Zolang er een geldt, nemen deze verzoeken een veld checklist aan: [{"key": "id_checked", "done": true}, {"key": "reason", "note": "Refused"}], of een object van key naar true of notitietekst. POST /items, PATCH /items/{id}, POST /items/{id}/disposition, POST /claims/{id}/handover, POST /claims/{id}/decision, POST /parcels/{id}/collect, POST /parcels/{id}/return, POST /parcels/bulk-return, POST /parcels/rounds/{round}/stops/{stop}/deliver, POST /checkroom/tickets, POST /checkroom/tickets/{id}/hand-back, POST /loans, POST /loans/{id}/return, POST /loans/returns, POST /loans/checkouts, POST /loans/reservations/{id}/pickup, POST /visitors, POST /visitors/{id}/sign-in en POST /visitors/{id}/sign-out accepteren het. Zonder de vereiste stappen is het antwoord 422 met de code checklist_incomplete en een object checklist dat de stappen noemt die nog moeten worden bevestigd, en er verandert niets. Wanneer er geen checklist geldt, wordt het veld genegeerd. De voltooide checklists, met wie ze bevestigde en wanneer, staan in checklists bij de antwoorden over één voorwerp, claim, pakket, ticket, uitgifte en bezoek.
| Code | Wat het betekent |
|---|---|
checklist_incomplete | 422: een workflowchecklist geldt voor deze stap en de vereiste stappen zijn niet bevestigd. |
Nieuwe pogingen met een Idempotency-Key-header kunnen ook antwoorden met een code:
| Code | Wat het betekent |
|---|---|
idempotency_key_invalid | 400: de header bestaat niet uit 1 tot 191 zichtbare ASCII-tekens. |
idempotency_key_reused | 422: deze sleutel is al gebruikt voor een ander verzoek. |
idempotency_in_progress | 409: het eerste verzoek met deze sleutel loopt nog. Probeer het zo meteen opnieuw. |
offline_in_progress | Het eerste exemplaar van deze offline actie wordt nog opgeslagen. Het apparaat stuurt hem zo meteen opnieuw. |
Een verzoek dat een teamlid noemt in X-Acting-User kan ook antwoorden met een code:
| Code | Wat het betekent |
|---|---|
acting_user_refused | 403: de header noemt niet precies één actief teamlid van deze locatie, of de sleutel is een verbinding die via inloggen is gemaakt. |
acting_user_role | 403: het genoemde teamlid kan de scope van deze bewerking niet gebruiken met zijn rol op de locatie. |