Sitecore API catalog/Sites API/Editor Profiles

Editor Profiles

The Editor Profiles API lets you manage which tools users can access in their page builder editor toolbar. Use the Editor Profiles API to create and manage editor profiles with configured tool sets. When editing in the page builder, the tools a user can access are based on the editor profile assigned to that site. To assign an editor profile to a site, update that site. For more information on configuring an editor profile, see Customize the rich text editor toolbar.

Operations

List all profiles

Request

Fetches a list of all profiles in the environment, with associated details.

Security
Bearer
curl -i -X GET \
  https://xmapps-api.sitecorecloud.io/api/ui/v1/editorprofiles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
Array [
idstring or null

The identifier of the profile. Example value: 123e4567-e89b-12d3-a456-426614174000

Example:"123e4567-e89b-12d3-a456-426614174000"
namestring or null

The name of the profile. Example value: Basic Editing

Example:"Basic Editing"
profilestring or null

The tools configured for this profile. Example value: {"toolbar":{"items":["bold","italic","underline","link","bulletedList","numberedList"]}}

Example:"{\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"
]
Response
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Basic Editing",
    "profile": "{\"toolbar\":{\"items\":[\"bold\",\"italic\",\"underline\",\"link\",\"bulletedList\",\"numberedList\"]}}"
  }
]