v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Get Project Details

Get the project details of a specific project.

The response will include details about the project, along with company specific details for the company associated with the JWT token specified.

get/v1/project/{project_id}/

Path parameters

project_idinteger required

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"
    }
  }
}