Get Active Projects

GET /public/v1/projects

Headers

  • X-COMPANY-ID string(uuid) Required

Query parameters

  • filters array[string]
  • asOf string

Responses

  • 500 */*

    Internal Server Error

  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer(int64) Required

      Project ID

    • initialProjectId integer(int64) Required

      The first id that was assigned to this project, it may change as the project is rebuilt.

    • name string Required

      The name of the project

    • startDate string(date) Required

      The start date of the project

    • country string Required

      The country where the project is located

    • city string Required

      The city where the project is located

    • state string Required

      The state where the project is located

    • zipcode string Required

      The zipcode or postal code where the project is located

    • latitude number Required

      The latitude where the project is located

    • longitude number Required

      The longitude where the project is located

    • originalScenarioId integer(int64) Required

      The id of the scenario which has all schedules and is tracking to the end of the schedule

    • defaultScenarioId integer(int64) Required

      The id of the scenario which has been selected as the primary scenario

    • underConstruction boolean Required

      Flag indicating whether the project is actively being rebuilt or not

    • projectPlanId string Required

      The id of the plan that the project is currently on

    • projectPlanSlotCount integer(int64) Required

      The number of slots that the plan is taking based on the activity count

    • weatherStationId string Required

      The id of the weather station that is closest to the project

    • metadata object Required

      The project specific metadata

      Hide metadata attribute Show metadata attribute object
      • * string Additional properties
    • companyId string Required

      The id of the company that the project is in

    • source string Required

      The scheduling system that the project is from

      Values are SmartPM, XER, MPP, Excel, PMXML, PPX, or PP.

    • dataDate string(date-time) Required

      The data date for the latest schedule that has been uploaded to the project

    • status string Required

      The status for the project in SmartPM

      Values are ACTIVE, INACTIVE, or COMPLETE.

    • currentModelId integer(int64) Required

      The id of the model for the primary scenario

    • currentModelName string Required

      The name of the model for the primary scenario

GET /public/v1/projects
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500)
{}
Response examples (200)
[
  {
    "id": 42,
    "initialProjectId": 42,
    "name": "string",
    "startDate": "2025-05-04",
    "country": "string",
    "city": "string",
    "state": "string",
    "zipcode": "string",
    "latitude": 42.0,
    "longitude": 42.0,
    "originalScenarioId": 42,
    "defaultScenarioId": 42,
    "underConstruction": true,
    "projectPlanId": "string",
    "projectPlanSlotCount": 42,
    "weatherStationId": "string",
    "metadata": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "companyId": "string",
    "source": "SmartPM",
    "dataDate": "2025-05-04T09:42:00Z",
    "status": "ACTIVE",
    "currentModelId": 42,
    "currentModelName": "string"
  }
]