Skip to content

Using the API

Apps access TYPO3 through the HTTP API described in this chapter: its endpoints and versions, the authentication with static tokens or OAuth, scopes and the actions for records and files. The complete reference of all endpoints, with their parameters and results, is available as interactive API documentation.

Your installation also shows its own API documentation, with the record schemas of its extensions, see API documentation (OpenAPI).

API reference (Swagger UI)

All endpoints, for a TYPO3 installation without other extensions.

Open the API reference

Endpoints

How actions map to HTTP methods and paths, and how they are versioned and deprecated.

Authentication

Bearer tokens, the backend session and the OAuth 2.0 authorization code flow.

Scopes

The scopes available by default and what they grant.

Record actions

Read and modify the records of all tables described by TCA, also in workspaces.

File and folder actions

Browse and manage the files and folders of the file storages.

Responses and errors

The status codes of the API and the format of its errors.

Backend JavaScript

Call the API from the JavaScript of a backend module.

API documentation (OpenAPI)

The OpenAPI document of the API and how to browse it.