PlanGrid

{"id":"55d2023b3c74062300aee506","name":"PlanGrid","subdomain":"plangrid","versions":[{"version":"1.0-beta.1","version_clean":"1.0.0-beta.1","codename":"Projects & Issues","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"560078de97f69f1700f219ef","releaseDate":"2015-09-21T21:38:38.583Z"},{"version":"1.0-beta.2","version_clean":"1.0.0-beta.2","codename":"Issue Comments & Photos","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"561bb66589a95f190027f082","releaseDate":"2015-10-12T13:32:21.448Z"},{"version":"1.0-beta.3","version_clean":"1.0.0-beta.3","codename":"RFIs","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"562926c348742a0d0047460a","releaseDate":"2015-10-22T18:11:15.185Z"},{"version":"1.0-beta.4","version_clean":"1.0.0-beta.4","codename":"Create Project & Team Management","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"563ab8070ed633230037889e","releaseDate":"2015-11-05T01:59:35.888Z"},{"version":"1.0-beta.5","version_clean":"1.0.0-beta.5","codename":"Create & Update RFIs","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"5653cc6ebae85c210093dfe7","releaseDate":"2015-11-24T02:33:18.990Z"},{"version":"1.0-beta.6","version_clean":"1.0.0-beta.6","codename":"Upload RFI Attachments","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"5676ede9ce37aa1700f0d2d5","releaseDate":"2015-12-20T18:05:29.542Z"},{"version":"1.0-beta.7","version_clean":"1.0.0-beta.7","codename":"Upload Photos","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"569593ff0c650a2300250628","releaseDate":"2016-01-13T00:02:07.234Z"},{"version":"1.0-beta.8","version_clean":"1.0.0-beta.8","codename":"List Attachments, Photos, RFI History","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"56aff2f0b34d210d003d9bce","releaseDate":"2016-02-02T00:06:08.527Z"},{"version":"1.0-beta.9","version_clean":"1.0.0-beta.9","codename":"Upload Version","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"56c671cd266b980d00988cb5","releaseDate":"2016-02-19T01:37:17.015Z"},{"version":"1.0-beta.10","version_clean":"1.0.0-beta.10","codename":"Get Sheet, Update Project, UD Attachments/Photos, Remove RFI References","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":true,"_id":"56de2291475ab30e00bcdd9b","releaseDate":"2016-03-08T00:53:37.780Z"},{"version":"1.0","version_clean":"1.0.0","codename":"Get Drawing Log, Update User, Delete Snapshot","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5702fc1618ad001700a29585","releaseDate":"2016-04-04T23:43:18.287Z"},{"version":"1.1","version_clean":"1.1.0","codename":"Sheet Exports","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5783f344dc13061900ed6430","releaseDate":"2016-07-11T19:28:04.331Z"},{"version":"1.2","version_clean":"1.2.0","codename":"Comments","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"57b0dafb4c0c6f0e000077fb","releaseDate":"2016-08-14T20:56:27.188Z"},{"version":"1.3","version_clean":"1.3.0","codename":"Rate Limits","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"57dadb72b103490e006dd682","releaseDate":"2016-09-15T17:33:38.864Z"},{"version":"1.4","version_clean":"1.4.0","codename":"List Snapshots","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"57fe838cfe877f1700b8673b","releaseDate":"2016-10-12T18:40:12.921Z"},{"version":"1.4-copywriting.1","version_clean":"1.4.0-copywriting.1","codename":"Reflect API Doc Guidelines","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"58039b6d37cb7d0f0041c72e","releaseDate":"2016-10-16T15:23:25.615Z"},{"version":"1.5","version_clean":"1.5.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5813c37a65c70a0f00681e16","releaseDate":"2016-10-28T21:30:34.412Z"},{"version":"1.5-copywriting.1","version_clean":"1.5.0-copywriting.1","codename":"Add Slack invite copy, add sheet_packet.create type in rate_limits endpoint","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"582349328e822419000426d6","releaseDate":"2016-11-09T16:05:06.476Z"},{"version":"1.5.1","version_clean":"1.5.1","codename":"Reflect changes to project role UIDs","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5841b976c7e458190091c8e5","releaseDate":"2016-12-02T18:12:06.212Z"},{"version":"1.6","version_clean":"1.6.0","codename":"Annotations","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5877d5cc511a4e2500f91d77","releaseDate":"2017-01-12T19:15:24.700Z"},{"version":"1.6.1","version_clean":"1.6.1","codename":"Batching","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5887ff6e238ec019000b7ba1","releaseDate":"2017-01-25T01:29:18.956Z"},{"version":"1.6.2","version_clean":"1.6.2","codename":"Fix RFI sent and due dates","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"589cb813c1131a19000419f3","releaseDate":"2017-02-09T18:42:27.461Z"},{"version":"1.7","version_clean":"1.7.0","codename":"OAuth","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"58a204279833fa3100f3a474","releaseDate":"2017-02-13T19:08:23.096Z"},{"version":"1.8","version_clean":"1.8.0","codename":"Project Profiles","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"58ec060b8d5a860f00852173","releaseDate":"2017-04-10T22:24:11.066Z"},{"version":"1.8-copywriting.1","version_clean":"1.8.0-copywriting.1","codename":"Publish to Project","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"58fe37462b628c0f0033a792","releaseDate":"2017-04-24T17:35:02.277Z"},{"version":"1.9","version_clean":"1.9.0","codename":"OAuth implicit flow, update issue, get user profile","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"597f637496a9ec001448fefa","releaseDate":"2017-07-31T17:05:56.079Z"},{"version":"1.9-copywriting.1","version_clean":"1.9.0-copywriting.1","codename":"HTTP compression, Update Project Users Object","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5994c29e078ec3000f0d6149","releaseDate":"2017-08-16T22:09:34.103Z"},{"version":"1.9-copywriting.2","version_clean":"1.9.0-copywriting.2","codename":"Remove `updated_after` for RFI comments","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"59c4267167a94900103a2560","releaseDate":"2017-09-21T20:52:01.026Z"},{"version":"1.9-copywriting.3","version_clean":"1.9.0-copywriting.3","codename":"Change `Attachments` to `Documents`, clarification on OAuth refresh tokens for Implicit flow","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"59d654c2e30053001052c7d9","releaseDate":"2017-10-05T15:50:26.736Z"},{"version":"1.10","version_clean":"1.10.0","codename":"Issue Lists","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5a0487bf1058cd003cfb7a9b","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.11","version_clean":"1.11.0","codename":"Issues Multiple Assignees and Watchlists","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5b041424769904000374c5a3","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.12","version_clean":"1.12.0","codename":"Renumber and Delete RFI","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5b314e650abfe00003a95fde","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.13","version_clean":"1.13.0","codename":"Tasks","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5bc621a6bcc5310023bf49b5","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.14","version_clean":"1.14.0","codename":"Field Reports","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5bd852901a0f4400134d2a68","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.15","version_clean":"1.15.0","codename":"Field Report Objects (Equipment, Materials, Worklog), Task Start Date, Closed At","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5c5092ac8d5174005c83879d","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.16","version_clean":"1.16.0","codename":"Create project and add to organization, auto version documents, export without annotations","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":true,"_id":"5cdde55205114d005d1abf1e","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.17","version_clean":"1.17.0","codename":"RFI v2, Submittals","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":true,"_id":"5d4b15a42fab660026cfdbd6","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.18","version_clean":"1.18.0","codename":"PG Connect Support Site, commenting on tasks","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"_id":"5d890403165d9e0032c19d5e","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.19","version_clean":"1.19.0","codename":"Create Annotations","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"_id":"5e4259ab5d0eac0039dff5b7","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.20","version_clean":"1.20.0","codename":"Field Report Custom Items, Field Report Templates","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"_id":"5e4323085390680012e7726a","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.20-org-admin","version_clean":"1.20.0-org-admin","codename":"Org Admin","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":false,"_id":"5e7a66c3e2db5902b76c71ca","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.17-submittals","version_clean":"1.17.0-submittals","codename":"Submittals docs for customers","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"_id":"5e8cbea307634f00118978f9","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.17-rfi2","version_clean":"1.17.0-rfi2","codename":"RFIv2 Beta","is_stable":false,"is_beta":true,"is_hidden":false,"is_deprecated":false,"_id":"5e9dfb5f1f810f0030491906","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.21","version_clean":"1.21.0","codename":"Release version for Submittals,","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"_id":"5ec1c6f4e22981004c1a3433","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.22","version_clean":"1.22.0","codename":"Advanced RFIs Final","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"_id":"5ecd75071d702000396072a2","releaseDate":"2017-11-09T16:52:15.503Z"},{"version":"1.23","version_clean":"1.23.0","codename":"Field Report Enhancements","is_stable":false,"is_beta":false,"is_hidden":true,"is_deprecated":false,"_id":"5f12319e2667040359f14388","releaseDate":"2017-11-09T16:52:15.503Z"}],"current_version":{"version_clean":"1.22.0","version":"1.22"},"oauth":{"enabled":false},"api":{"name":"","url":"https://io.plangrid.com","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[{"key":"key","default":"","type":"ba_username","_id":"560c5d84e10d100d00dbd6a9"}],"headers":[{"key":"Accept","value":"application/vnd.plangrid+json; version=1","_id":"57046d608c69510e00b1df77"}],"object_definitions":[]},"apiAlt":[{"name":"Staging","url":"https://plangrid-capi-dispatch-staging.herokuapp.com","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"_id":"570308aab3cd0e20009ba442","object_definitions":[],"headers":[{"key":"Accept","value":"application/vnd.plangrid+json; version=1","_id":"57030930f2d6f336005e9064"}],"authextra":[{"key":"key","default":"","type":"ba_username","_id":"570308d7b3cd0e20009ba443"}]},{"name":"No API Explorer","url":"https://io.plangrid.com","contenttype":"json","auth":"","explorer":false,"proxyEnabled":true,"jwt":false,"_id":"588bb90f33b1b337002e64e7","object_definitions":[],"headers":[{"key":"Accept","value":"application/vnd.plangrid+json; version=1","_id":"588bb94ce840643900a40ba6"}],"authextra":[{"key":"","default":"","type":"ba_username","_id":"588bb93e6aca6f2500d116a5"}]},{"name":"OAuth","url":"https://io.plangrid.com","contenttype":"form","auth":"","explorer":true,"proxyEnabled":true,"jwt":false,"_id":"58a619d52cb5710f0070d0de","object_definitions":[],"headers":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","_id":"58a61a165d720d0f009f8b77"}],"authextra":[]},{"name":"Test","url":"https://plangrid-c-api-dispatcher-test.planfront.net","contenttype":"json","auth":"token","explorer":true,"proxyEnabled":true,"jwt":false,"_id":"5983811b3a35b30034b2f473","object_definitions":[],"headers":[{"key":"Accept","value":"application/vnd.plangrid+json; version=1","_id":"5983817e5de0a1002049f2d4"}],"authextra":[{"key":"key","default":"","type":"ba_username","_id":"5983817e5de0a1002049f2d3"}]}],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":true,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"ssl":true,"newApiExplorer":false,"newSearch":true},"asset_base_url":""}
  • Documentation
  • Updates
  • Support

PlanGrid Developer

Welcome to PlanGrid Developer. You'll find comprehensive guides and documentation to help you build integrations and apps on the PlanGrid platform. Our goal is to get you started as quickly as possible, so jump right in!

Get Started

Introduction

  • Introduction
  • Support
  • Conventions
  • Libraries, SDKs, and Packages
  • Access
  • Quick Start
  • View All 6

Standards

  • Basics
  • Authentication
  • API Versioning
  • Deleted Records
  • File Uploads
  • Foreign Keys
  • Pagination
  • Permissions
  • Rate Limiting
  • Timestamps and Timezones
  • Unique Identifiers
  • View All 11

Common Objects

  • The File Upload Object
  • The Shareable Object
  • View All 2

Batch Requests

  • Why Batch Requests?
  • The Batch Request Object
  • postSend Batch Request
  • View All 3

OAuth

  • Getting Started with OAuth
  • Grant Type: Authorization Code
  • Grant Type: Implicit
  • OAuth Scopes
  • The OAuth Token Object
  • getRetrieve Authorization Code
  • postRetrieve Access Token
  • View All 7

Projects

  • The Project Object
  • postCreate Project
  • getList All Projects
  • getRetrieve a Project
  • patchUpdate Project
  • View All 5

Project Annotations

  • The Annotation Object
  • getRetrieve Annotations in a Project
  • View All 2

Project Comments

  • The Comment Object
  • getRetrieve Comments in a Project
  • View All 2

Project Documents

  • The Document Object
  • Supported File Types
  • postUpload Document to Project
  • getComplete Document Upload to Project
  • getRetrieve Documents in a Project
  • getRetrieve Document in a Project
  • patchUpdate Document in a Project
  • deleteRemove Document from Project
  • View All 8

Project Field Reports

  • The Field Report Object
  • The Field Report Template Object
  • The Custom Item Object
  • The Equipment Entries Object
  • The Materials Entries Object
  • The Worklog Entries Object
  • The Weather Object
  • getRetrieve Field Reports in a Project
  • getRetrieve Field Report Templates in a Project
  • View All 9

Project Photos

  • The Photo Object
  • postUpload Photo to Project
  • getComplete Photo Upload to Project
  • getRetrieve Photos in a Project
  • getRetrieve Photo in a Project
  • patchUpdate Photo in a Project
  • deleteRemove Photo from Project
  • View All 7

Project RFIs

  • The RFI Object
  • The RFI History Object
  • postCreate RFI in a Project
  • getRetrieve RFIs in a Project
  • getRetrieve RFI in a Project
  • getRetrieve Documents Referenced in RFI
  • getRetrieve Photos Referenced in RFI
  • getRetrieve Snapshots Referenced in RFI
  • getRetrieve Comments on an RFI
  • getRetrieve RFI History
  • patchUpdate RFI in a Project
  • postReference Document in RFI
  • deleteRemove Document Reference in RFI
  • postReference Photo in RFI
  • deleteRemove Photo Reference in RFI
  • deleteRemove Snapshot Reference in RFI
  • View All 16

Project RFI Statuses

  • The RFI Status Object
  • getRetrieve RFI Statuses in a Project
  • patchUpdate RFI Status in a Project
  • View All 3

Project Advanced RFIs

  • The RFI Object
  • The RFI Annotation Object
  • The RFI Answer Object
  • The RFI History Object
  • The RFI Reference Object
  • postCreate RFI in a Project
  • getRetrieve RFIs in a Project
  • getRetrieve RFI in a Project
  • getRetrieve RFI Annotations in a Project
  • getRetrieve RFI History in a Project
  • patchUpdate RFI in a Project
  • deleteDelete RFI in a Project
  • postCreate RFI Answer in a Project
  • getGet RFI Answers in a Project
  • patchUpdate RFI Answer in a Project
  • The RFI Return Message Object
  • postCreate RFI Return Message in a Project
  • getGet RFI Return Message in a Project
  • View All 18

Project Advanced RFIs Statuses

  • The RFI Status Object
  • getRetrieve RFI Statuses in a Project
  • patchUpdate RFI Status in a Project
  • View All 3

Project Roles

  • The Role Object
  • getRetrieve Roles on a Project
  • getRetrieve Role on a Project
  • View All 3

Project Sheets

  • The Sheet Object
  • Uploading a New Version
  • The Version Upload Object
  • The File Upload Request Object
  • postUpload Version to Project
  • getComplete File Upload to Version
  • postUpload File to Version
  • postComplete Version Upload to Project
  • getRetrieve Sheets in a Project
  • getRetrieve a Sheet
  • postCreate Sheet Packet
  • getRetrieve Sheet Packet
  • View All 12

Project Snapshots

  • The Snapshot Object
  • getRetrieve Snapshots in a Project
  • getRetrieve Snapshot in a Project
  • deleteRemove Snapshot from Project
  • View All 4

Project Submittals

  • The Submittal Items Object
  • The Submittal Packages Object
  • The Submittal Package File Groups Object
  • The Submittal Package History Object
  • The Submittal Package Review Status Object
  • postCreate Submittal Item in a Project
  • postCreate Submittal Package in a Project
  • getRetrieve Submittal Items in a Project
  • getRetrieve Submittal Packages in a Project
  • getRetrieve Submittal Package in a Project
  • getRetrieve Submittal Package History
  • getRetrieve Submittal Package File Groups in a Project
  • getRetrieve Submittal Package Review Status in a Project
  • patchUpdate Submittal Item in a Project
  • patchUpdate Submittal Package in a Project
  • deleteDelete Submittal Item in a Project
  • deleteDelete Submittal Package in a Project
  • View All 17

Project Tasks

  • Background
  • The Task Object
  • postCreate Task in a Project
  • getRetrieve Tasks in a Project
  • getRetrieve Task in a Project
  • getRetrieve Comments on a Task
  • getRetrieve Photos on an Task
  • patchUpdate Task in a Project
  • View All 8

Project Task Lists

  • The Task List Object
  • postCreate Task List in a Project
  • getRetrieve Task Lists in a Project
  • getRetrieve Task List in a Project
  • patchUpdate Task List in a Project
  • deleteDelete Task List in a Project
  • View All 6

Project Users

  • The User Object
  • postInvite User to Project Team
  • getRetrieve Users on a Project Team
  • getRetrieve User on a Project Team
  • patchUpdate User on a Project Team
  • deleteRemove User from Project Team
  • View All 6

Rate Limits

  • The Rate Limit Object
  • getRetrieve Rate Limits
  • View All 2

User Profile

  • The User Profile Object
  • getGet User Profile
  • View All 2