Sitecore Authoring and Management GraphQL API

The Sitecore Authoring and Management API provides a single endpoint and schema that allows you to manage your Sitecore content using GraphQL. The API allows you to extend XM Cloud with custom dialogs and user interfaces. You can use the API to perform tasks previously possible only through the Sitecore user interface. You can use the API to create custom authoring experiences.

The API offers read/write flexibility and is upgrade-safe, meaning you do not have to implement in-process customizations that are hard to manage with subsequent upgrades.

Endpoint

You use the Authoring and Management API at the endpoint:

RequestResponse
https://<your-instance>/sitecore/api/authoring/graphql/v1/

GraphQL IDE

You can explore the Authoring and Management API with an interactive browser-based GraphQL IDE.

Using the IDE requires that you are at least in the sitecore\Sitecore Client Users role.

The GraphQL IDE is available at:

RequestResponse
https://<your-instance>/sitecore/api/authoring/graphql/playground/

You must enable and authorize the GraphQL IDE before running queries or referencing the schema and built-in documentation.

Do you have some feedback for us?

If you have suggestions for improving this article,