REST: Plan API

Overview

The Plan API is the primary starting point for programmatically finding exports, tile templates, and taking measurements. It provides a combined list of maps and flight plans, allowing you to access metadata for all plans or a specific plan in your account.

Availability: Who has access?

The REST API is available to Enterprise users with admin or owner permissions. Users must generate an API key from the Account Preferences section in the DroneDeploy dashboard to use these endpoints.

Prerequisites

Before using the Plan API, you must have a valid API key. If you do not have one:

1. Navigate to the Account Preferences tab.

2. Click Generate to create a new key.

3. Click Copy to save the key to your clipboard.

List all plans

In order to list all plans available in your account, send a GET request to /v2/plans.
This will fetch the first page of 50 plans. To request more, see API Pagination

GET /v2/plans

Returns JSON - List of all plans and associated metadata

curl "https://public-api.dronedeploy.com/v2/plans?api_key={api_key}"

[  
  {
    "log": "EXAMPLE_000002",
    "id": "5605c0e5752afc005a000004",
    "location": {
      "lat": 35.92596388888889,
      "lng": -96.74810972222222
    },
    "image_count": 66,
    "date_creation": 1377012456330,
    "latest_started_map": {
      "user_status": "Complete"
    },
    "name": "Construction Example"
  },
  {
    "log": "EXAMPLE_000001",
    "id": "56048e63752afc0058000001",
    "location": {
      "lat": 48.60367083333334,
      "lng": -97.21722638888889
    },
    "image_count": 301,
    "date_creation": 1372605078006,
    "latest_started_map": {
      "user_status": "Complete"
    },
    "name": "Agriculture Example"
  }
]

Get all data for a specific plan

To get all data for a specific plan in your account.

GET /v2/plans/<planid>

• The plan_id can be obtained by listing all plans (above)

Returns JSON - Detailed plan metadata and links

curl "https://public-api.dronedeploy.com/v2/plans/5605c0e5752afc005a000004?api_key={api_key}"

{
  "log": "EXAMPLE_000002",
  "id": "5605c0e5752afc005a000004",
  "location": {
    "lat": 35.92596388888889,
    "lng": -96.74810972222222
  },
  "image_count": 66,
  "date_creation": 1377012456330,
  "latest_started_map": {
    "user_status": "Complete"
  },
  "name": "Construction Example"
}

Limitations

• The REST API is considered a legacy technology. DroneDeploy recommends using the GraphQL API for more robust functionality and updated features. Please go to our API explorer page and our developer page for our new, more robust GraphQL based APIs.

• Standard requests are limited to 50 results per page.

• The REST API does not currently support all newer product workflows available in the GraphQL schema.

FAQs

Q: Does DroneDeploy plan to decommission the REST API? 
A: There are no plans to decommission the REST API at this time.

Q: Where do I find the plan ID? 
A: You can find the unique ID by sending a GET request to the /v2/plans endpoint or by viewing the URL of the plan in the DroneDeploy web app.

Q: Can I get help with API development? 
A: Your DroneDeploy account team provides guidance and answers questions regarding API integration, but we do not offer custom development services.

v2.2