DotCMS API Documentation

This is the complete API documentation for connecting to the DotCMS API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet DotCMS: DotCMS is a hybrid CMS and digital experience platform for managing content, pages, sites, workflows, users, templates, and related administrative resources through a large REST API surface. Keep reading to get started.

Quickstart

Before you run your first DotCMS request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one DotCMS connection — create or choose one in Connections. Note its connectionId.

Every DotCMS action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/dotCMS/latest/actions/{actionSlug}

You need a MindCloud API Key and a DotCMS connection. Then call an action such as Export Categories:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/dotCMS/latest/actions/export-categories" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected DotCMS account that should run the action. MindCloud stores and refreshes the DotCMS credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

DotCMS actions

All 31 published actions for this DotCMS version. Each page documents the endpoint, arguments, and response controls.

• GETExport Categories
• GETFilter Users
• GETGet App Configuration
• GETGet Content Type Base Types
• GETGet Current Site
• GETGet Current User
• GETGet Default Site
• GETGet Health
• GETGet Health Liveness
• GETGet Health Readiness
• GETGet Health Status
• GETGet Login As Data
• GETGet Menus
• GETList Apps
• GETList Categories
• GETList Content Types
• GETList Field Types
• GETList Languages
• GETList Languages V2
• GETList Page Types
• GETList Permissions
• GETList Relationship Cardinalities
• GETList Role Layouts
• GETList Roles
• GETList Site Thumbnails
• GETList Sites
• GETList Tags
• GETList Templates
• GETList Workflow Actionlets
• GETList Workflow Schemes
• GETSearch Roles

Related apps

More Website & App Building apps on the Universal API, behind the same REST shape. Or browse all apps.

WordPressGhostCommon NinjaSubpageEasyContentSiteleafLook Digital SignageVoog