PlanRadar Plans V2 API

Load/Manage plans

Business capability
Drawing Management BC-1130.20

Operations 4

GET /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans/{id} Returns specific plan of a component #
PUT /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans/{id} Update specific plan of a component #
GET /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans Returns all plans of a component #
PUT /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans/{id}/skip_approval_request Skip approval request for this plan #

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-plans-v2-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.

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

OpenAPI Specification

planradar-plans-v2-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: PlanRadar's API Documentation Plans V2 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:
- name: Plans V2
  description: Load/Manage plans
paths:
  /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans/{id}:
    get:
      summary: Returns specific plan of a component
      tags:
      - Plans V2
      security:
      - apiKey: []
      description: This API returns a specific plan of a component based on its id.
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: component_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: id of the plan
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Plan Not Found
      operationId: getApiV2ByCustomerIdProjectsByProjectIdComponentsByComponentIdPlansById
      x-operation-id-source: derived
    put:
      summary: Update specific plan of a component
      tags:
      - Plans V2
      security:
      - apiKey: []
      description: This API update a specific plan of a component based on its id.
      x-websocket-response:
        channel: customer_{customerId}
        message_type: defectradar-components
        payload:
          type: object
          properties:
            plan-status:
              type: string
              description: Plan processing status
            customer-id:
              type: integer
            project-id:
              type: integer
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: component_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: id of the plan
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Plan Not Found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    attributes:
                      type: object
                      properties:
                        plan_scale:
                          type: object
                          example:
                            calibrate_scale:
                              point_1:
                                x: 0.3
                                y: 0.6
                              point_2:
                                x: 0.2
                                y: 0.4
                              distance: 4
                              unit: cm
                              width_px: 0.6
                              height_px: 1.2
                            calibrate_north:
                              south:
                                x: 0.2
                                y: 0.4
                              north:
                                x: 0.2
                                y: 0.4
      operationId: putApiV2ByCustomerIdProjectsByProjectIdComponentsByComponentIdPlansById
      x-operation-id-source: derived
  /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans:
    get:
      summary: Returns all plans of a component
      tags:
      - Plans V2
      security:
      - apiKey: []
      description: This API returns all plans of a component based on the component's id.
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: component_id
        in: path
        required: true
        schema:
          type: string
      - name: is_simple
        in: query
        description: send is_simple with true for retrieving simple plan versions data
        schema:
          type: boolean
      responses:
        '404':
          description: Plans Not Found
      operationId: getApiV2ByCustomerIdProjectsByProjectIdComponentsByComponentIdPlans
      x-operation-id-source: derived
  /api/v2/{customer_id}/projects/{project_id}/components/{component_id}/plans/{id}/skip_approval_request:
    put:
      summary: Skip approval request for this plan
      tags:
      - Plans V2
      security:
      - apiKey: []
      description: This api will remove the plan from an approval request if it belong to one and delete the approval request if it the last one included
      x-websocket-response:
        channel: customer_{customerId}
        message_type: defectradar-components
        payload:
          type: object
          properties:
            plan-status:
              type: string
              description: Plan processing status
            customer-id:
              type: integer
            project-id:
              type: integer
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: component_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Plan ID
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Plan Not Found
      operationId: putApiV2ByCustomerIdProjectsByProjectIdComponentsByComponentIdPlansByIdSkipApprovalRequest
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-PlanRadar-API-Key
      in: header
externalDocs:
  description: Find out more about our development portal
  url: https://www.planradar.com/knowledge-base-overview/