PlanRadar

PlanRadar DMS API

Document Management System: browse, manage and copy DMS nodes, ticket attachments and form-field attachments

GitHub OpenAPI
Business capability
Common Data Environment BC-5060.20

Operations 44

GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes Retrieves All nodes [folder|files] for a specific projects #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes Create New Node[folder] or a new file #
PATCH /api/v2/{customer_id}/projects/{project_id}/dms/nodes execute a bulk update action #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments/{ticket_uuid} Create New Ticket Attachment #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/{ticket_uuid} Create New Form Field Attachment #
PATCH /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/{id} Update a Form Field Attachment #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments Retrieves All ticket attachments files for a specific projects #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments Retrieves all form field attachments for a specific project #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/ticket_attachments/delete Delete Ticket Attachment #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/form_field_attachments/delete Delete Form Field Attachment #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/attachments Retrieves all attachments (ticket + form field) for a specific project #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/attachments/delete Delete attachments (ticket or form field) #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id} show node[folder] or file details #
PATCH /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id} update node[folder] or file #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id} mark node[folder] or file as deleted #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/copy create another copy under different folder for a file/folder #
PUT /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/trash move file or folder to the trash bin #
PUT /api/v2/{customer_id}/projects/{project_id}/dms/nodes/trash execute a bulk trash #
PUT /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/restore restore file/folder from trash bin #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy execute a bulk copy , this is only works with files ! #
PUT /api/v2/{customer_id}/projects/{project_id}/dms/nodes/restore execute a bulk restore #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/delete execute bulk delete #
PATCH /api/v2/:customer_id/projects/:project_id/dms/nodes/:id/toggle toggle the control access switch #
PATCH /api/v2/:customer_id/projects/:project_id/dms/nodes/:id/restore_permissions restore permissions #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets_validation validate before copying files to tickets #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms_validation validate before copying ticket attachments to DMS #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_attachments_to_dms copy ticket attachments to DMS #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/copy_to_tickets validate before copying files to tickets #
GET /api/v2/{customer_id}/projects/{project_id}/dms/bookmarks Retrieves All the bookmarks for a user #
POST /api/v2/{customer_id}/projects/{project_id}/dms/bookmarks Create New bookmark #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/bookmarks/{bookmark_id} delete bookmark #
GET /api/v2/{customer_id}/projects/{project_id}/dms/sidebar_sections Retrieves DMS sections #
GET /api/v2/{customer_id}/projects/{project_id}/dms/logs/{item_type}/{item_id} Retrieves DMS activity logs #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/files_size Retrieves DMS files size for a specific project #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions upload new version of the file attachment #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions load the file attachment version #
DELETE /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id} delete file attachment version #
GET /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id} load file attachment version details #
POST /api/v2/{customer_id}/projects/{project_id}/dms/nodes/{node_id}/versions/{id}/restore Restore file attachment version #
GET /api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions Retrieves All permissions for a specific node #
POST /api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions create a permission entry for a specific role|user to access specific node #
DELETE /api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions/:id delete access permission for the list #
PUT /api/v2/:customer_id/projects/:project_id/dms/nodes/:node_id/permissions/:id update access|permission type for a permission #
GET /api/v2/:customer_id/projects/:project_id/dms/nodes/list_roles_and_users list roles and users #

Documentation

📖
APIReference
https://www.planradar.com/api-docs/index.html
📖
Documentation
https://help.planradar.com/hc/en-gb/articles/15480453097373-Open-API-Overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/planradar/refs/heads/main/openapi/planradar-dms-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/planradar:planradar-dms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

planradar-dms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PlanRadar's API Documentation DMS API
  version: '2.0'
  description: Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.
servers:
- url: /
tags:


# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/planradar/refs/heads/main/openapi/planradar-dms-api-openapi.yml