Open API Overview

Overview

PlanRadar provides secure REST APIs which are open to all customers for their own integrations.
On top of that PlanRadar also provides PlanRadar Connect to build custom automations and integrations with third-party applications without coding. Read more in PlanRadar Connect.

The REST API features resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication. 

Access & Permissions

Use Open APIs

When using the APIs, you can send up to 30 requests per minute. Exceeding this limit results in disabling your authorisation token for 5 minutes. In case of special requirements please contact our support team.

API Access Authorisation

When consuming an API, you need to add the authorisation key as a header value of “X-PlanRadar-API-Key". The authorisation key can be obtained by generating Personal Access Tokens and using them to authenticate your API requests. 

Available APIs

You can access the documentation about available API's either here or in the WebApp following the instructions below:

1. Click Settings
2. Click API Documentation
3. Enter your password
4. Click Confirm
   

   

5. Select the feature you want to show its APIs
   

   

6. A list of all of the APIs related to that feature will appear
   

   

Sample API Request

Here's a sample of using APIs to call project details:

API URL:

GET /api/v1/{customer_id}/projects

Request body:

{
  "data": {
    "attributes": {
      "name": "Your Project Name"
    }
  }
}

Response body:

{
  "data": {
    "id": "aqbqod",
    "type": "projects",
    "attributes": {
      "id": "aqbqod",
      "name": "Your Project Name",
      "homepage": "",
      "country": null,
      "projectnumber": null,
      "description": null,
      "city": null,
      "zipcode": null,
      "street": null,
      "author-id": "pxpp",
      ...
    }
  }
}

Core API Concepts

Learn about the fundamental concepts behind our APIs. Read more in Core API Concepts.

API Tutorials

Explore step-by-step tutorials on how to use our APIs in the following areas:

API Tutorials for User Endpoints

API Tutorials for Project Endpoints

API Tutorials for Ticket Endpoints

API Tutorials for Document Endpoints

API Tutorials for Schedule Endpoints

API Changelog

Review the latest updates and changes to our APIs. Read more in API Changelog.