Planning Analytics Workspace REST API

Use the Planning Analytics Workspace REST API to manage content programmatically without using the user interface.

Use the Planning Analytics Workspace REST API to build scripts, tools, or third-party applications that interact with Workspace functions. You can access REST APIs for operations such as managing content, accessing data, and integrating with external systems.

For a comprehensive collection of Planning Analytics API references and examples of how to use them, see Planning Analytics in the Postman API Network website.

Available REST APIs

Three types of REST APIs are accessible through Planning Analytics Workspace:

Planning Analytics Workspace APIs
APIs for managing Workspace-specific functions, such as content management (books, views, folders). These APIs are accessed at https://<paw_host>/api/v1/content/...

This initial release includes endpoints for content management. Other endpoints will be added in future releases.

TM1 REST APIs
APIs for accessing TM1® database functions, such as cubes, dimensions, and data operations. These APIs are accessed through Planning Analytics Workspace at https://<paw_host>/api/v1/tm1/<database_name>/api/v1/...

For complete documentation of TM1 REST API endpoints, see the TM1 REST API.

MCP endpoints
APIs for AI-enabled tools and integrations. These endpoints support Model Context Protocol (MCP) for AI tool integration.

Base URL structure

All REST APIs are accessible through the Planning Analytics Workspace host by using the following base URL pattern:

https://<paw_host>/api/v1/...

Where <paw_host> is your Planning Analytics Workspace deployment hostname and port.

In multi-tenant deployments, REST API requests must include the tenant identifier in the request path. The tenant identifier is visible in the browser URL when you access the tenant in Planning Analytics Workspace.

Authentication

All REST API endpoints require authentication before they can be accessed. You must configure OAuth authorization to enable external applications and services to access REST APIs on behalf of users.

For information about configuring OAuth authentication, see Configuring authorized applications (OAuth).

Prerequisites

  • Planning Analytics Workspace 3.1.8 or later, or 2.1.21 or later
  • OAuth client configured for API access
  • Valid user credentials with appropriate permissions for the operations you want to perform

Getting started

To use the Planning Analytics Workspace REST API:

  1. Configure OAuth authentication to obtain client credentials.
  2. Use a REST API client (such as Postman, cURL, or a programming language HTTP library) to make API requests.
  3. Include the OAuth access token in the Authorization header of your API requests.
  4. Construct API requests by using the appropriate endpoint URLs and HTTP methods.