---
title: "API reference"
description: "The complete reference of all endpoints of the HTTP API, with their parameters and results, in Swagger UI."
canonical: index.html
navigation-title: "API reference"
---

<a id="api-reference"></a>

# API reference

The HTTP API of a TYPO3 instance with EXT:hub, as provided at
`/typo3/api/v1/schema`. Replace `https://example.org/` with the address of
your instance. See [Using the API](../usage/index.md#usage) for authentication and usage.

> [!NOTE]
> TYPO3 derives the schemas of the record actions from the TCA of the
> instance. This reference shows a TYPO3 installation without other
> extensions. The tables and fields of your instance depend on its
> extensions and configuration. To see the API documentation of your
> instance, see [API documentation (OpenAPI)](../usage/open-api.md#usage-openapi).

```html
<link rel="stylesheet" href="swagger-ui.css">
<link rel="stylesheet" href="swagger-soul.css">
<div id="swagger-ui"></div>
<script type="module">
    import { SwaggerUIBundle } from './swagger-ui-dist.js';

    SwaggerUIBundle({
        url: 'openapi.json',
        dom_id: '#swagger-ui',
        presets: [SwaggerUIBundle.presets.apis],
        layout: 'BaseLayout',
        supportedSubmitMethods: [],
        syntaxHighlight: false,
    });
</script>
```