REremihq
Project

Get projects

Changed on

Get all projects for a given bid request

get/v0/projects

Request

  • Base URL
    https://api.remihq.com
  • URL
    https://api.remihq.com/v0/projects
  • Auth
    API key in header x-remi-key

Query parameters

idstring required

Unique identifier of the bid request

Example:XXXX1234
organizationIdstring

Organization to which the bid request belongs

Example:remi

Response

Projects retrieved successfully

Example response

{
  "projects": [
    {
      "id": 12345,
      "phase": {
        "phaseType": "pending_ntp",
        "phaseStartDate": "2024-01-01T00:00:00.000Z"
      },
      "deadline": "2024-01-01T00:00:00.000Z",
      "completedDate": "2024-01-01T00:00:00.000Z",
      "createdDate": "2024-01-01T00:00:00.000Z",
      "updatedDate": "2024-01-01T00:00:00.000Z",
      "category": "full_roof",
      "installScheduledAt": "2024-01-01T00:00:00.000Z",
      "installStartedAt": "2024-01-01T00:00:00.000Z",
      "installCompletedAt": "2024-01-01T00:00:00.000Z",
      "estimatedProductionDays": 10,
      "projectStatus": "done",
      "cancellationReason": "on_hold_for_60_days"
    }
  ]
}

Changes

  • 70ffee4fb697Revision changes
    • warning

      added the new live_visit enum value to the // response property for the response status

  • 2cb7e848888fRevision changes
    • warning

      added the new qa enum value to the // response property for the response status