Projects
      Back to home
      1. ConstructionOnline API Documentation
      2. Projects + Opportunities
      3. Projects

      Projects Overview

      Discover more about the project object and its related properties

      Table of Contents

      1. Introduction
      2. Project Object
      3. Endpoints

      Introduction

      In ConstructionOnline, a project serves as the central point of organization for all the various details of an individual construction job. Each project reveals specific details about a job—such as its location, contract price, type, and stage—in addition to the job's estimate, schedule, files & photos, change orders, and various other components of project management. Projects can also be assigned a specific project team, which consists of all contacts who are associated to the project. This could include company employees, clients, subcontractors, vendors, and other contacts. More information about projects in ConstructionOnline can be found in the Essential Guide to Projects. 

      Project Object

      The project object represents an individual project in ConstructionOnline. Each project object returns multiple properties that reveal specific details about the project, such as its name, contract price, address, and scope of work. Each property corresponds to a specific detail from within the Project itself, which can be found within Project Details or from a specific feature like Files. 

      Each project object is referenced by a unique numerical ID, which is stored in the property 'ID'. A project's ID is automatically assigned during creation and cannot be modified. Please note that a project's ID is not the same as its project number in ConstructionOnline. To update or return a specific project, you must know the project's ID. Each project object will contain at least a 'NAME', as this property is required for creation. The remaining project object properties are optional. Some properties are automatically assigned a default value when a project is created. Others will return null if a value has not been set for the specific property. 

      Name Type Description
      ID integer Unique identifier for the project.
      NAME string Name of the project.
      CREATED_BY integer Unique identifier for the user who created the project. 
      CREATOR_NAME string Name of the user who created the project.
      LMOD date Date and time the project was last modified.
      ADDRESS string Project's address.
      CITY string Project's city.
      STATE string Project's state.
      ZIP string Project's zip code.
      PROJECT_NUMBER string Project number assigned to the project.
      LMOD_CON_ID integer Unique identifier for the user who last modified the project.
      IS_ARCHIVED boolean Signifies if the project was archived.
      IS_TEMPLATE boolean Signifies if the project was created from a project template.
      CURRENCY integer Type of currency set for the project. Each type of currency corresponds to a specific number, which will be returned in this property. 
      COUNTRY_SETTING integer Number representing the specific country associated with the project.
      CUSTOM_COLOR string Project's color as it appears in ConstructionOnline. Returns the specific hex code for the color.
      COMPANY_ID string Unique identifier for the company associated with the project.
      IS_INACTIVE boolean Signifies if the project has a status of 'Live' or 'Pending'. Returns true if the project is Pending, false if the project is Live.
      LAT double Project's entered latitude coordinates.
      LON double Project's entered longitude coordinates.
      SCOPE_OF_WORK string Scope of work entered for the project. Returns as an encoded string.
      IS_UNGROUPED boolean Only returns true for "My Documents", which returns as a project object. Returns null for actual projects.
      TOTAL_TIME integer Initial project duration .
      TOTAL_MONEY decimal  Initial contract price.
      PROJECT_NOTES string Notes entered for the project.
      NUMBERFOLDERS integer Number of folders saved within the project.
      NUMBERIMAGES integer Number of images saved within the project.
      NUMBERALBUMS integer Number of albums saved within the project.
      NUMBERFILES integer Number of files saved within the project.
      DATE_CREATED date Date and time the project was created.
      PROJECT_TYPE string Name of the project type assigned to the project. The unique numerical ID for the specific project type is listed in the property 'PROJECT_TYPE_CUSTOM'.
      ATTACH_FOLDER_ID integer Attachment folder location for daily logs, to dos, etc. 
      PERMISSION_X integer Project-specific permissions for the user accessing project data via the API. Individual permissions are available for: FILES, CALENDAR, TIME TODOS, SCHEDULING, PUNCHLISTS, CHANGE ORDERS, SELECTIONS, LOGGING, RFIS, TRANSMITTALS, SUBMITTALS, ESTIMATING, and CHECKLISTS.
      ESTIMATE_UNQUALIFIED_COMMITS decimal Total value of any imported POs from QuickBooks that do not match anything in the estimate.
      ESTIMATE_UNQUALIFIED_ACTUALS decimal Total value of any imported actuals from QuickBooks that do not match anything in the estimate.
      ESTIMATE_UNQUALIFIED_EXPENSES decimal Total value of any imported invoices from QuickBooks that do not match anything in the estimate.
      SELECTION_UNQUALIFIED_COMMITS decimal Total value of any imported POs from QuickBooks that do not match any selections.
      SELECTION_UNQUALIFIED_ACTUALS decimal Total value of any imported actuals from QuickBooks that do not match any selections.
      SELECTION_UNQUALIFIED_EXPENSES decimal Total value of any imported invoices from QuickBooks that do not match any selections.
      CHANGE_ORDER_UNQUALIFIED_COMMITS decimal Total value of any imported POs from QuickBooks that do not match any change orders.
      CHANGE_ORDER_UNQUALIFIED_ACTUALS decimal Total value of any imported actuals from QuickBooks that do not match any change orders.
      CHANGE_ORDER_UNQUALIFIED_EXPENSES decimal Total value of any imported invoices from QuickBooks that do not match any change orders.
      PRIMARY_SCHEDULE integer Unique numerical ID representing the schedule tied to the project. 
      COST_CODE_SET integer Number associated with the cost code list assigned to the project. Returns null if a cost code list has not been assigned.
      JOBSITE_INSTRUCTIONS string Job site instructions for the project.

      In addition to the properties above, project objects also return properties that reference custom values for the user's company account. Custom values are fields that can be customized for each company to best fit their specific needs, and are denoted by a gear icon ⚙️ beside the field heading.

      Each custom value property will return the numerical ID that represents the specific custom value entry assigned to the project. To ensure you know the meaning of the returned value, we highly recommend storing your company's custom value entries in a data table or collection for reference. This endpoint can be used to return all custom values for your company's account.

      Name Type Description
      PROJECT_TYPE_CUSTOM integer Corresponds to the 'Project Type' custom value. Returns the numerical ID for the specific project type associated with the project. The name of the specific type is listed in the property 'PROJECT_TYPE'.
      PROJECT_REGION integer Corresponds to the 'Region' custom value. Returns the numerical ID for the specific region associated with the project.
      PROJECT_DIVISION integer Corresponds to the 'Division' custom value. Returns the numerical ID for the specific division associated with the project.
      PROJECT_OFFICE integer Corresponds to the 'Office' custom value. Returns the numerical ID for the specific office associated with the project.
      PROJECT_CATEGORY integer Corresponds to the 'Contact Category' custom value. Returns the numerical ID for the specific category associated with the project.
      PROJECT_STAGE integer Corresponds to the 'Project Stage' custom value. Returns the numerical ID for the specific stage associated with the project. 
      PROJECT_GROUP integer Corresponds to the 'Project Group' custom value. Returns the numerical ID for the specific contact group associated with the project.