v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Create a Project

Create a project.

This creates a project and automatically adds company owners as users to that project.

post/v1/project/

Request body

namestring required

The name of the project.

addressstring required

The address of the project site.

citystring required

The city of the project site.

countrystring required

The country of the project site.

timezonestring required

The timezone associated with the project site.

phonestring nullable

The main phone number associated with the project site.

longitudenumber nullable

The longitude of the project site.

latitudenumber nullable

The latitude of the project site.

musterPointstring nullable

The muster point for the project site.

isPrivateboolean

Indicates that a project is private.

geoCheckInEnabledboolean

Enable or disable having workers get automatically checked in and out of the site based on their location

Example request

{
  "name": "The Project Name",
  "address": "123 Somewhere Ave",
  "city": "Vancouver",
  "country": "Canada",
  "timezone": "America/Vancouver",
  "phone": "16045551234",
  "longitude": 35.89421911,
  "latitude": 139.94637467,
  "isPrivate": true,
  "geoCheckInEnabled": true,
  "companyProject": {
    "externalId": "100123",
    "externalSystemName": "Procore",
    "displayName": "Company Prefix - Project Name",
    "accountingName": "ACCT-SYS-01-PRJ-NAME",
    "jobNumber": "001-PRJ-NAME",
    "siteClass": "Site Class",
    "nearestHospital": "Vancouver General Hospital",
    "nearestClinic": "Alberni Medical Clinic",
    "firstAidAttendant": "Jane Doe",
    "siteLinkOne": "https://example.com",
    "siteLinkTwo": "https://example.com",
    "siteLinkThree": "https://example.com",
    "udf1": "Canada Division",
    "udf2": "BC Division",
    "udf3": "Eli's team"
  }
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 123,
    "name": "The Project Name",
    "address": "123 Somewhere Ave",
    "city": "Vancouver",
    "country": "Canada",
    "timezone": "America/Vancouver",
    "phone": "16045551234",
    "longitude": 35.89421911,
    "latitude": 139.94637467,
    "siteCode": 54231,
    "isPrivate": true,
    "geoCheckInEnabled": true,
    "companyProject": {
      "externalId": "100123",
      "externalSystemName": "Procore",
      "udf1": "Canada Division",
      "udf2": "BC Division",
      "udf3": "Eli's team",
      "displayName": "Company Prefix - Project Name",
      "accountingName": "ACCT-SYS-01-PRJ-NAME",
      "jobNumber": "001-PRJ-NAME",
      "siteClass": "Site Class",
      "nearestHospital": "Vancouver General Hospital",
      "nearestClinic": "Alberni Medical Clinic",
      "firstAidAttendant": "Jane Doe",
      "siteLinkOne": "https://example.com",
      "siteLinkTwo": "https://example.com",
      "siteLinkThree": "https://example.com",
      "udf1Label": "Division",
      "udf2Label": "Subdivision",
      "udf3Label": "Team"
    }
  }
}