Get the status of a planning request

GET /v1/status/id
Api key auth

Path parameters

  • id string Required

Responses

  • 200 application/json

    Planning status result

    Hide response attributes Show response attributes object
    • status string Required

      Values are Pending, Running, Completed, or Failed.

    • result object
      Hide result attributes Show result attributes object
      • assignments array[object] Required
        Hide assignments attributes Show assignments attributes object
        • workOrderId string Required
        • employeeId string | null
        • start string(date-time) Required
        • end string(date-time) Required
      • issues array[object] Required
        Hide issues attributes Show issues attributes object
        • type string Required

          Values are PinnedAssignmentWithoutEmployee, InvalidStartDate, EmployeeWithoutWorkHours, InvalidAddress, NoMaintenanceDateTime, CouldNotBeAssigned, PinnedAssignmentStartDateAfterEndDate, or WorkOrderDurationTooShort.

        • workOrderId string | null
        • employeeId string | null
        • locationId string | null
        • metadata object Required
          Hide metadata attribute Show metadata attribute object
          • * string Additional properties
GET /v1/status/id 
curl \
 --request GET 'https://api.planrobot.nl/v1/status/id?key=api_token_value'
Response examples (200) 
{
  "status": "Pending",
  "result": {
    "assignments": [
      {
        "workOrderId": "string",
        "employeeId": "string",
        "start": "2025-05-04T09:42:00Z",
        "end": "2025-05-04T09:42:00Z"
      }
    ],
    "issues": [
      {
        "type": "PinnedAssignmentWithoutEmployee",
        "workOrderId": "string",
        "employeeId": "string",
        "locationId": "string",
        "metadata": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      }
    ]
  }
}