{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5bc456b8-aae3-4110-812d-6b125b35bbb2","name":"BuiltGrid - Builder Apps","description":"The following endpoints connect **construction management or estimating apps** to the BuiltGrid construction software platform and supply chain network. Leveraging our API endpoints, you can create a cohesive and efficient user experience and enable the seamless transfer of data from one platform to another within our extensive supply chain ecosystem. Integration with BuiltGrid streamlines procurement functions like quoting, ordering, chatting and scheduling with tens of thousands of trades and building materials suppliers. Trades and suppliers get the work they want, and builders get to build homes faster.\n\n[<b>Download our quick start summary</b>](https://builtgrid.com/wp-content/uploads/2025/05/Partner_Integration_Intro_Quick_Start_Jun2025.pdf)\n\n<img src=\"https://content.pstmn.io/0aa94456-698c-466e-8eac-4a6272181ecb/QnVpbHRHcmlkX0FQSV9QaGFzZTFfMjAyNS1QYXJ0bmVyX092ZXJ2aWV3X3Y1LnBuZw==\" alt=\"\">\n\n## Key procurement process\n\n| **Key functions** | In-app features |\n| --- | --- |\n| [Integrations page](https://builtgrid-official.postman.co/workspace/aac16ea4-c018-4a4b-b6e7-aff593aed5bd/folder/32527745-c2d78382-705b-4150-9fd6-a3f5d04f0337?action=share&source=copy-link&creator=32527745&ctx=documentation) | Connect to BuiltGrid account  <br>Sync vendors and items |\n| [Project/Estimate](https://builtgrid-official.postman.co/workspace/aac16ea4-c018-4a4b-b6e7-aff593aed5bd/folder/32527745-5e225534-64a4-4cdc-9115-50b9aa195313?action=share&source=copy-link&creator=32527745&ctx=documentation) | Create/update project  <br>Create/update project docs |\n| [Request for Quote (RFQ)](https://builtgrid-official.postman.co/workspace/aac16ea4-c018-4a4b-b6e7-aff593aed5bd/folder/32527745-38978895-b275-46c2-a5bf-b33d3b54e231?action=share&source=copy-link&creator=32527745&ctx=documentation) | Send RFQ  <br>RFQ job selection |\n| [Quotes<br>](https://builtgrid-official.postman.co/workspace/aac16ea4-c018-4a4b-b6e7-aff593aed5bd/folder/32527745-dd424612-45e2-42f0-adb1-ae39a1680ff3?action=share&source=copy-link&creator=32527745&ctx=documentation)While in development or testing mode using staging server, we need to manually submit quotes on your behalf to simulate supplier quote responses. Just send us a request by Slack or email. | Send quotes and docs  <br>Receive quotes and docs  <br>Or receive quote comparison  <br>(Eg. estimating apps) |\n| [Orders](https://builtgrid-official.postman.co/workspace/aac16ea4-c018-4a4b-b6e7-aff593aed5bd/folder/32527745-ff11d4e3-b98a-4497-96ac-c4d6b53d587f?action=share&source=copy-link&creator=32527745&ctx=documentation) | Send order  <br>Receive order  <br>Receive final contract  <br>Receive supplier details |\n| Integration: Stage #2 | Invoices  <br>Scheduling  <br>Chat  <br>Availability  <br>Payment |\n| Service regions | We currently service Australia, with other regions coming soon. |\n\n# Getting started guide\n\n## API Environments\n\nThere are two environments, including staging and production\n\n- Implement proper error handling for all API calls and redirects.\n    \n- Use HTTPS for all production communications to ensure security.\n    \n- Keep client secrets and tokens secure and never expose them to the client-side.\n    \n- The BuiltGrid authorisation server forces token refresh.\n    \n- Consider using OAuth 2.0 libraries specific to your programming language to simplify implementation and improve security.\n    \n\n## Servers\n\n**Staging**  \nWhen you are in development and testing APIs, please ensure server alias is set to \"staging_server\".\n\n**Production**  \nLive APIs are served from api.builtgrid.com. We will share separate client ID and client secret for production environment.\n\n## Branding and logos for your app\n\n**Tagline**  \nGet 9% project gains from Australia's #1 network of trades and suppliers for home builder procurement.\n\n**Description**  \nBuiltGrid is a software platform that streamlines procurement and connects tens of thousands of trades and building materials suppliers with home builders for pricing, quoting, ordering and scheduling in the estimating or construction management app you use daily.\n\nPlease use one of the following logos on your integrations page:\n\n**SVG**  \n[https://builtgrid.com/assets/images/BuiltGrid_Logo_Colour_Wide.svg](https://builtgrid.com/assets/images/BuiltGrid_Logo_Colour_Wide.svg)\n\n**PNG**  \n[https://app.builtgrid.com/assets/media/BGD_Logo_Hori_500p.png](https://app.builtgrid.com/assets/media/BGD_Logo_Hori_500p.png)\n\n**Create free account**  \nIf your customer doesn't have a BuiltGrid account, please include a link below tagline \"Create free account\" and link to [https://app.builtgrid.com/create_account/?utm_source=[YourPartnerName]](https://app.builtgrid.com/create_account/)\n\n## **Testing and help**\n\nWe provide a dedicated slack channel for your team to communicate with our team directly.\n\nThe API endpoints we have provided will allow you to create a test from start to finish using the ids you insert. Most endpoints require specific ids of prior endpoints to be successful. The responses will highlight key information that is missing or incorrect.\n\n## BuiltGrid testing responses\n\nSince BuiltGrid is a two-sided system, there is one instance where you need to request our manual intervention to add quotes in response to a RFQ. This is only applicable in the staging environment.\n\nImmediately following a RFQ insert for an active project, if you want to check quote comparison or receive quotes, let us know and we will add quotes.\n\n**API inputs**\n\nWe implement strict input validation on the API side to disallow unsafe characters such  \nas <, > or as they are commonly used in scripting.\n\n<p>John Murphy<br><a href=\"https://mailto:developer@builtgrid.com\">developer@builtgrid.com</a><br>+61 412 233 750</p>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32527745","team":6295476,"collectionId":"5bc456b8-aae3-4110-812d-6b125b35bbb2","publishedId":"2sAYdeNCKz","public":true,"publicUrl":"https://api-docs.builtgrid.com","privateUrl":"https://go.postman.co/documentation/32527745-5bc456b8-aae3-4110-812d-6b125b35bbb2","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00AFEF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The following endpoints connect estimating or construction management apps to the BuiltGrid construction software platform and supply chain network. Leveraging our API endpoints, you can create a cohesive and efficient user experience and enable the seamless transfer of data within our extensive supply chain ecosystem."},{"name":"title","value":"BuiltGrid construction software platform and supply chain network"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/fcd59c7e-56a8-4bd7-b0d8-947ac8190184/QnVpbHRHcmlkX0xvZ29fV2hpdGVfU3F1YXJlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"00AFEF"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00AFEF"}}]}},"version":"8.10.1","publishDate":"2025-02-25T21:22:24.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"BuiltGrid construction software platform and supply chain network","description":"The following endpoints connect estimating or construction management apps to the BuiltGrid construction software platform and supply chain network. Leveraging our API endpoints, you can create a cohesive and efficient user experience and enable the seamless transfer of data within our extensive supply chain ecosystem."},"logos":{"logoLight":null,"logoDark":"https://content.pstmn.io/fcd59c7e-56a8-4bd7-b0d8-947ac8190184/QnVpbHRHcmlkX0xvZ29fV2hpdGVfU3F1YXJlLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/84ecf647253022cf7e7a81fd8e979f31b5ecc187052c4721749cb39307e98979","favicon":"https://res.cloudinary.com/postman/image/upload/v1720769089/team/qopysaono13cr3scqbtz.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.builtgrid.com/view/metadata/2sAYdeNCKz"}