General usage
Last updated on
5 June 2025
When accessing any route in Drupal, if the url includes format=json as a GET parameter, it will rerouted through the Transform API and instead of outputting HTML, it outputs JSON. This works for all entities and all controller routes as long as the appropriate plugin or configuration is present. It will also retain cachability and permission requirements.
If you want only want specific regions of a route, you can specify it using region=my-region as a GET parameter, or multiple regions separated by commas, like region=my-region,my-region2. That way you could load only the content or header of a page and minimize the json size.
User authentification is done through the JWT module.
Help improve this page
Page status: No known problems
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion
Still on Drupal 7? Security support for Drupal 7 ended on 5 January 2025. Please visit our Drupal 7 End of Life resources page to review all of your options.