# Introduction (/)



<span className="eyebrow">
  Get Started
</span>

Welcome to the Vizit Public API documentation. This site is the main entry point for customers integrating with Vizit's machine-to-machine API. Use it to understand how the API works, what standards apply across endpoints, and how to use individual operations in practice.

<CardGrid>
  <CardGridCard icon="book" title="Standards" href="/standards/authentication">
    Cross-cutting rules that apply across the API — authentication, error shapes, and pagination.
  </CardGridCard>

  <CardGridCard icon="compass" title="Guides" href="/guides/overview">
    Task-oriented walkthroughs and how-to material for common integration workflows.
  </CardGridCard>

  <CardGridCard icon="brackets" title="API Reference" href="/api">
    The full OpenAPI specification — endpoints, parameters, request bodies, responses, and examples.
  </CardGridCard>
</CardGrid>

## How to use this site [#how-to-use-this-site]

If you are new to the API, start with the standards pages. They explain the shared behaviors customers should expect across the API surface, including how authentication works, how error responses are shaped, and what pagination will look like on list endpoints.

After that, use the guides for practical integration walkthroughs, and use the [API Reference](/api) for the exact endpoint contract. The API Reference page is where you will find the OpenAPI spec rendered for browsing, including all request and response details for each operation.

## Standards at a glance [#standards-at-a-glance]

* [Authentication](/standards/authentication) explains how to obtain and use Bearer tokens for machine-to-machine access.
* [Errors](/standards/errors) explains the standard error response format and the HTTP status codes used across the API.
* [Pagination](/standards/pagination) explains the pagination model customers should expect on paginated endpoints.

## API Reference [#api-reference]

The full OpenAPI reference is available on the [API Reference](/api) page. That page is the source of truth for operation-level details such as:

* available endpoints
* path and query parameters
* request and response schemas
* examples for individual operations

Use the standards and guides to understand how the API behaves overall, and use the API Reference when you need the exact contract for a specific endpoint.