---
title: "API documentation | Vizito Help Center"
description: "API documentation | Where the Vizito REST API is documented: quickstart, endpoint reference, guides, webhooks and the OpenAPI specification. | Vizito | …"
url: https://vizito.eu/faq/integrations/api-documentation/
language: en
---

# API documentation

Vizito has a REST API your own systems can use to read and write visitor data. The complete documentation for it lives on its own site: [developers.vizito.eu](https://developers.vizito.eu/).

### What is on the developer portal?

-   **Quickstart**: from no credential to your first visitor list in a few minutes.
-   **Core concepts**: the handful of objects the whole API is built on, and how locations, visits and visit types relate.
-   **API reference**: every endpoint, per resource. Visitors, registered visitors, hosts, visit types, entry points, agreements, devices, reporting and webhooks, each with its parameters, an example request and an example answer.
-   **Guides**: signing a visitor in and out from your own system, pre-registering visitors and sending invitations, keeping hosts in sync with your directory, and receiving webhooks.

### What do I need before my first call?

An API key. Only global administrators can create one, on the Integrations page of the Backoffice. See [API access and API keys](https://vizito.eu/faq/integrations/api-keys/) for how to create, restrict and revoke one, and for authenticating with a Microsoft Entra ID application instead.

The base URL, the conventions that apply to every endpoint (ids, dates, custom fields, languages) and the meaning of each error code are on the [Introduction](https://developers.vizito.eu/api-reference/introduction) page.

### Is there an OpenAPI specification?

Yes. The specification is published at [vizito.eu/openapi.yaml](https://vizito.eu/openapi.yaml), so you can generate a client, import the API into Postman or Insomnia, or point your own tooling at it.

### Can Vizito notify us instead of us polling the API?

Yes, with a webhook. Vizito calls your endpoint the moment something happens, so you do not have to ask repeatedly whether anything changed. See [WebHooks](https://vizito.eu/faq/integrations/webhook/) in this help center for setting one up, and the [Webhooks guide](https://developers.vizito.eu/documentation/webhooks) on the developer portal for the payloads and events.

### Who can we ask about the API?

If something in the documentation is unclear or an endpoint does not behave as described, [contact us](https://vizito.eu/faq/contact/). Include the endpoint, the request you sent and the answer you got back.