Frequently asked questions about getting started with the ConstructionOnline API
Who is the ConstructionOnline API for?
Who is eligible for access to the ConstructionOnline API?
Who should I contact if I have questions regarding the API?
Can I use the API to integrate with other software tools?
How do I request access to the ConstructionOnline API?
What do companies use the ConstructionOnline API for?
Do I need the API to integrate with other software tools?
What do I need to start using the API?
Where can I view example responses for an API endpoint?
Are there any rate limits for the API?
What resources are available for developers using the API?
I'm looking for a specific endpoint or piece of information and cannot find it. What should I do?
Who is the ConstructionOnline API for?
The ConstructionOnline API is for successful, growth-minded construction companies looking to fully take advantage of the valuable project data within their ConstructionOnline account. Using the API, companies can build custom applications, integrate with powerful software tools such as Zapier, HubSpot, or Salesforce, create custom reports & dashboards, and more.
Companies that choose to use the ConstructionOnline API usually have on-staff technical resources or hire a dedicated team of developers that are in charge of the implementation or build processes. For this reason, many of the resources found in the ConstructionOnline API Documentation are specifically tailored for developers, such as the reference docs for endpoints.
Who is eligible for access to the ConstructionOnline API?
Companies with Business and Enterprise subscriptions to ConstructionOnline are eligible for read & write access to the ConstructionOnline API. API access is not automatically "turned on"; eligible companies must reach out to the ConstructionOnline development team and request access.
To request access to the API, please contact the ConstructionOnline development team at api@uda1.com. A member of our team will be in touch shortly after your request has been submitted.
Who should I contact if I have questions regarding the API?
If you have any questions regarding the ConstructionOnline API, please contact the ConstructionOnline development team at api@uda1.com. Our team will review your questions and get back to you as soon as possible.
Can I use the API to integrate with other software tools?
Yes! If you are looking to integrate with a software tool that does not currently have a native integration with ConstructionOnline, the API can be used to implement an integration between your ConstructionOnline data and the software tool. ConstructionOnline currently integrates with the following platforms: Google Drive, Google Calendar, OneDrive, Outlook Calendar, Dropbox, box, QuickBooks Online, QuickBooks Desktop, Planswift, and CAD imports. Any other software tools not listed must be integrated with ConstructionOnline using the API.
How do I request access to the ConstructionOnline API?
To request read & write access to the ConstructionOnline API, please contact the ConstructionOnline development team at api@uda1.com. A member of our development team will be in touch shortly after your request has been submitted.
Remember: only companies with Business and Enterprise subscriptions can request access for the API. If you are interesting in learning about these subscription plans, please contact the ConstructionOnline support team for more information.
What do companies use the ConstructionOnline API for?
There are a number of reasons why construction companies choose to use the ConstructionOnline API to supplement their businesses. Companies commonly use the API to:
- Integrate with accounting software tools such as Sage or JD Edwards
- Automate tasks and build custom workflows with Zapier
- Integrate with CRM software tools such as HubSpot or Salesforce
- Streamline data import & export
- Build custom dashboards and reports
Do I need the API to integrate with other software tools?
It depends. If you want to integrate with a software tool that does not currently have a native integration with ConstructionOnline, you will need to use the API for integration. However, if you want to integrate with tools such as Google Drive or QuickBooks Online, you can use ConstructionOnline's built-in integrations to connect your data between the two tools. A full list of software tools that have native integrations with ConstructionOnline can be found below:
ConstructionOnline currently integrates with the following platforms: Google Drive, Google Calendar, OneDrive, Outlook Calendar, Dropbox, box, QuickBooks Online, QuickBooks Desktop, Planswift, and CAD imports.
What do I need to start using the API?
To start making calls to the ConstructionOnline API, you will need:
- Your ConstructionOnline login credentials (email address and password)
- An API key
- A development environment
More instructions for getting an API key and setting up a basic development environment can be found in our Quick Start Guide.
Where can I view example responses for an API endpoint?
Each endpoint documented in ConstructionOnline's API Documentation has its own individual reference guide. Every reference doc contains a sample JSON response for the endpoint, as well as sample code snippets that can be used to make the request, parameter/payload requirements, and any additional information pertaining to the endpoint.
Are there any rate limits for the API?
Yes, there are hourly, daily, weekly, and monthly rate limits for using the ConstructionOnline API. The API limits 500 requests per hour, with the rate limit resetting every hour.
Additional rate limits for daily, weekly, and monthly use can be found below.
| Hourly Limit | 500 requests per hour |
| Daily Limit | 10,000 requests per day |
| Weekly Limit | 50,000 requests per week |
| Monthly Limit | 200,000 requests per month |
What resources are available for developers using the API?
There are many resources available for developers looking for help or assistance with the ConstructionOnline API.
ConstructionOnline API Documentation
The ConstructionOnline API Documentation page is the primary source of all documentation for the ConstructionOnline API. The Getting Started section contains introductory resources for those who want to learn more about the API, as well as technical resources for developers setting up the API for the first time.
The other sections of ConstructionOnline's API Documentation contain reference guides for each endpoint of the ConstructionOnline API. These sections are organized by feature and are grouped together by the common object they return or reference, such as "Projects" or "Contacts". Each endpoint has its own reference guide page that breaks down what the endpoint does, what a typical response would be, any parameter or payload requirements, code snippets, and any additional points of information that a developer should know for that endpoint.
ConstructionOnline Knowledge Base
The ConstructionOnline Knowledge Base is a library of self-serve, user-facing documentation for ConstructionOnline. The Knowledge Base contains overview pages, frequently asked questions (FAQs), step-by-step articles, visual workflows, instructional videos, and additional resources for ConstructionOnline users learning to work with the various features of ConstructionOnline.
ConstructionOnline Development Team
If you have additional questions, encounter any issues, or have any requests concerning the API or its documentation, you can contact the ConstructionOnline development team for more support. The development team can be contacted at api@uda1.com.
I'm looking for a specific endpoint or piece of information and cannot find it. What should I do?
The ConstructionOnline API is actively being updated at this time. Documentation for additional API endpoints and functions will be added in the near future. If you are looking for a specific endpoint that is not currently documented, please contact the ConstructionOnline development team at api@uda1.com.
Last updated: Dec 14, 2023