Endpoints

Each action of the HTTP API has an endpoint below /typo3/api/ of the TYPO3 backend. The path of the record and file actions starts with the version of the action, for example /typo3/api/v1/records/pages. The type of the action sets the HTTP method:

Type	HTTP method
fetch	`GET`
create	`POST`
replace	`PUT`
update	`PATCH`
delete	`DELETE`
dispatch	`POST`

A placeholder in the path, for example {uid}, gets the value of the parameter with the same name. Send the other parameters as follows:

For GET and DELETE, send them as query parameters.
For POST, PUT and PATCH, send them as properties of a JSON object in the request body, with the header Content-Type: application/json. Some actions also accept query parameters for these methods, for example workspace.
Encode arrays and objects in a query parameter as JSON.
An action that receives the content of a file takes the raw request body. Send its other parameters as query parameters, see File and folder actions.

Some actions are only for the backend user interface, for example the generation of static tokens. They are not part of the HTTP API. A request with the token of an app returns the status 404.

Versions and deprecation#

Each action has its own version. An incompatible change of an action gets a new version, for example /typo3/api/v2/…. The previous version stays available. This also applies to the OpenAPI document at /typo3/api/v1/schema.

The OpenAPI document marks a deprecated version. Its responses contain the header Deprecation with the date of the deprecation (RFC 9745):

text

Deprecation: @1793608038

The next major version of TYPO3 removes a deprecated version. Change your clients to the newest version of the action. The API does not send a Sunset header, because the date of the removal depends on the update of the installation to the next major version.