POST /rest/v1.0/projects

Create a new Project in a Procore account. The new project is active by default.

Country and State codes

The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.

Recommendation

For accounts creating a significant number of projects (more than 300), schedule these operations during non-business hours (5 P.M PST - 7 A.M PST) to optimize efficiency. Coordinate the timing with your solution architect for insights into system load and effective resource utilization.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Procore-Company-Id Integer Yes

Unique company identifier associated with the Procore User Account.

Query parameters

Name Type Required Description
run_configurable_validations Boolean No

If true, validations are run for the corresponding Configurable Field Set.

Default value: false

Request body fields

Name Type Required Description
company_id Integer Yes

The company identifier the project is associated with.

project Object Yes
project.project_bid_type_id Integer No

The project bid type identifier.

project.store_number String No

The project store number.

project.override_end_date_check Boolean No

This is the property that enables the use of the override_end_date as the Projected Finish Date.

project.currency_configuration Object No

This object will initialize the project currency configuration

project.currency_configuration.exchange_rate_override Number No

-> This optional parameter is used to populate a fixed initial project to company exchange rate, company exchange rate for the project currency iso code will be used instead if this parameter is missing

project.currency_configuration.currency_iso_code String Yes

The currency iso code for the new project, must be available in the company exchange rates list

project.origin_data String No

External third-party data string associated with the project.

project.accounting_project_number String No

The project accounting project number.

project.square_feet Integer No

The total square footage of the project.

project.estimated_value Number No

The estimated value of the project. Note: This field is now deprecated and will mirror the value of total_value until it is no longer supported.

project.enable_copy_of_standard_cost_codes Boolean No

This property enables the user to copy default standard cost codes during new project creation when it is set to true. However, this flag does not have any impact when using project template, and the company's configuration is set to copy project template cost codes.

Default value: false

project.designated_market_area String No

The project designated market area.

project.longitude Number No

Project longitude

project.zip String No

The project postal code.

project.total_value Number No

The total amount of construction work performed, planned, or put in place during the project. Note: This field is a replacement of estimated_value and will mirror its value.

project.office_id Integer No

The project office identifier.

project.public_notes String No

The public notes for the project.

project.sector String No

The sector of a project.

Possible values:

  • "casino_hotel"
  • "specialist_office"
  • "industrial"
  • "railways"
  • "auto_vehicle_terminal"
  • "district_operations"
  • "indoor"
  • "energy"
  • "transportation"
  • "bank"
  • "event_space"
  • "government_buildings"
  • "sports_courts"
  • "urgent_care"
  • "student_housing"
  • "office"
  • "police_station"
  • "jail_prison"
  • "playground"
  • "psychiatric_hospital"
  • "residential"
  • "high_school"
  • "grocery_store"
  • "data_center"
  • "death"
  • "fire_station"
  • "rehab_facility"
  • "educational"
  • "dry_storage"
  • "public_safety"
  • "big_box_store"
  • "rv_park"
  • "telecommunication"
  • "single_family"
  • "wind_power"
  • "runway_taxiway"
  • "department_store"
  • "distillery"
  • "entertainment"
  • "street_lights"
  • "dealership"
  • "automobile_retail"
  • "energy_distribution"
  • "city_hall_operations"
  • "religious_institution"
  • "residential_office_retail"
  • "retail"
  • "storage"
  • "liquor_store"
  • "gas_station"
  • "animal_health_veterinary"
  • "hazardous_storage"
  • "commercial"
  • "auto_parts_store"
  • "outdoor"
  • "zoo_aquarium"
  • "energy_production"
  • "convention_center"
  • "pipe_line"
  • "waste_water"
  • "water_distribution"
  • "hydro_power"
  • "daycare_pre_k"
  • "self_storage"
  • "multifamily"
  • "oil_gas_mining"
  • "sports_fields"
  • "college_university"
  • "terminal"
  • "courthouse"
  • "stadium_arena"
  • "airport"
  • "race_track"
  • "railway_terminal"
  • "miscellaneous_pavement"
  • "solar_power"
  • "civil_infrastructure"
  • "residential_retail"
  • "battery_energy_storage"
  • "waste_collection"
  • "campground"
  • "tunnel"
  • "winter_sports"
  • "health_care"
  • "telecommunication_lines"
  • "entertainment_production"
  • "reservoir"
  • "k_12"
  • "agriculture"
  • "lodging"
  • "water_retention"
  • "bowling_alley"
  • "manufacturing"
  • "waste_processing"
  • "cemetery"
  • "hospitality"
  • "specialty_store"
  • "military_naval"
  • "environmentally_controlled"
  • "casino"
  • "funeral_home"
  • "waste_infrastructure"
  • "production"
  • "cultural"
  • "restaurant"
  • "sidewalk_walkways"
  • "water_treatment_plant_wwtp"
  • "government"
  • "car_wash"
  • null
  • "parking_lot"
  • "nuclear_power_plant"
  • "amusement_park"
  • "drug_store"
  • "dam"
  • "brewery"
  • "aviation"
  • "personal_service"
  • "electrical_substation"
  • "outpatient_care"
  • "convenience_store"
  • "medical_office_building_mob"
  • "business_park"
  • "middle_school"
  • "distribution_warehouse"
  • "hangar"
  • "animal_lodging"
  • "park"
  • "sewer_systems"
  • "roads_highways"
  • "behavioral_health"
  • "hotel"
  • "mixed_use"
  • "assembly"
  • "alcohol_establishment"
  • "elementary_school"
  • "bridges"
  • "water_infrastructure"
  • "pool_swim_facility"
  • "research_development"
  • "library"
  • "performing_arts"
  • "office_retail"
  • "post_office"
  • "shopping_center_mall"
  • "individual_space"
  • "parking_garage"
  • "auto_service"
  • "winery"
  • "movie_theater"
  • "senior_housing"
  • "medical_center"
  • "trailer_park"
  • "fast_food_restaurant"
  • "institutional"
  • "transportation_terminals"
  • "bar_tavern"
  • "museum"
  • "gym_athletic_studio"
  • "dental"
  • "golf"
  • "recreation"
  • "energy_storage"
  • "hospital"
project.department_ids[] Array No

The department ids the project is associated with. The array should represent all departments, so if the current value is [1, 2, 3] and want to remove department 2, then send [1, 3].

project.erp_integrated Boolean No

The project will be ERP integrated.

Default value: false

project.country_code String No

The country code (ISO-3166 Alpha-2 format) where the project is located.

project.override_start_date String No

This is the date that the project started and will be displayed on the portfolio page.

project.estimated_completion_date String No

The estimated completion date of the project. Note: This field is now deprecated and will mirror the value of completion_date until it is no longer supported.

project.name String Yes

The project name.

project.image_id Integer No

The project image identifier.

project.state_code String No

The state code (ISO-3166 Alpha-2 format) where the project is located.

project.phone String No

The project telephone number.

project.project_owner_type_id Integer No

The project owner type identifier.

project.description String No

The project description.

project.latitude Number No

Project latitude

project.code String No

The project code.

project.city String No

The city where the project is located.

project.origin_code String No

External third-party code associated with the project.

project.flag String No

The project flag.

Possible values:

  • "Green"
  • "Red"
  • "Yellow"
project.estimated_start_date String No

The estimated start date of the project. Note: This field is now deprecated and will mirror the value of start_date until it is no longer supported.

project.active Boolean No

The project active status.

Default value: true

project.start_date String No

The date that the contract for the project is signed. Note: This field replaces estimated_start_date and will mirror its value.

project.warranty_end_date String No

The project warranty end date.

project.project_stage_id Integer No

The project stage identifier.

project.origin_id String No

External third-party identifier for the project.

project.locale String No

The locale for the Project. (Note that your account may not have access to all locales.)

Possible values:

  • "es-ES"
  • "pt-BR"
  • "es"
  • "th-TH"
  • "zh-SG"
  • "en"
  • "pseudo"
  • "fr-FR"
  • "de-DE"
  • "en-budget"
  • "ja-JP"
  • "en-AE"
  • "ko"
  • "pl-PL"
  • "es-419"
  • "en-US-x-owner"
  • "en-CA"
  • "en-GB"
  • "en-owner"
  • "fr-CA"
  • "en-AU"
  • "en-SG"
  • "en-US-x-sc"
project.program_id Integer No

The project program identifier.

project.delivery_method String No

The delivery method of a project.

Possible values:

  • "public_private_partnership_p3"
  • "design_bid_build_dbb"
  • null
  • "construction_manager_as_agent_owners_rep"
  • "other"
  • "design_build_db"
  • "indefinite_delivery_indefinite_quantity_idiq"
  • "construction_management_at_risk_cmar"
  • "integrated_project_delivery"
  • "multi_prime"
project.time_zone String No

The timezone where the project is located.

project.project_template_id Integer No

The project template identifier as designated by another project on this company. It must be a project that is a template defined by template: true.

project.project_region_id Integer No

The project region id of the project.

project.override_start_date_check Boolean No

This is the property that enables the use of the override_start_date as the Actual Start Date.

project.work_scope String No

The work scope of a project.

Possible values:

  • "new_construction"
  • "renovation_alteration"
  • null
  • "maintenance_service"
project.completion_date String No

The date that all parties agree the project meets or must meet “substantial completion”. Note: This field replaces estimated_completion_date and will mirror its value.

project.warranty_start_date String No

The project warranty start date.

project.override_end_date String No

This is the date that the project will be finished and will be displayed on the portfolio page.

project.project_type_id Integer No

The project type identifier.

project.parent_job_id Integer No

The project's parent job identifier.

project.address String No

The street address of the project.

project.project_number String No

The project number.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.