• Submit a planning request
      POST
    • Get the status of a planning request
      GET
    • Schemas
      • PlanningInput
      • PlanningSubmittedResult
      • PlanningStatusResult
      • PlanningStatus
      • PlanningResult
      • Issue
      • IssueType
      • WorkOrderAssignmentRuleIntervalUnit
      • PinnedWorkOrderAssignment
      • WorkOrderAssignment
      • Location
      • WorkOrderAssignmentRule
      • PeriodDates
      • Employee
      • Address
      • GeoLocation

      Submit a planning request

      POST
      /v1/plan

      Request

      Authorization
      API Key
      Add parameter in query
      key
      Example:
      key: ********************
      or
      Body Params application/jsonRequired

      Examples

      Responses

      🟢200
      application/json
      Planning submitted successfully
      Body

      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST '/v1/plan?key=<api-key>' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "customerCode": "string",
          "start": "2019-08-24T14:15:22.123Z",
          "employees": [
              {
                  "id": "string",
                  "homeAddress": {
                      "address": "string",
                      "zipCode": "string",
                      "city": "string"
                  },
                  "homeGeo": {
                      "lat": 0,
                      "lng": 0
                  },
                  "workHoursMonday": 0,
                  "workHoursTuesday": 0,
                  "workHoursWednesday": 0,
                  "workHoursThursday": 0,
                  "workHoursFriday": 0,
                  "workHoursSaturday": 0,
                  "workHoursSunday": 0,
                  "unavailableDates": [
                      {
                          "start": "2019-08-24",
                          "end": "2019-08-24"
                      }
                  ]
              }
          ],
          "locations": [
              {
                  "id": "string",
                  "address": {
                      "address": "string",
                      "zipCode": "string",
                      "city": "string"
                  },
                  "geo": {
                      "lat": 0,
                      "lng": 0
                  }
              }
          ],
          "workOrderAssignmentRules": [
              {
                  "locationId": "string",
                  "durationInMinutes": 0,
                  "workOrderIds": [
                      "string"
                  ],
                  "priority": 0,
                  "interval": 0,
                  "intervalUnit": "Week",
                  "minimalDaysBetween": 0,
                  "expectMaintenance": true,
                  "maintenanceDate": "2019-08-24",
                  "availableDaysOfWeek": [
                      0
                  ],
                  "unavailableDates": [
                      {
                          "start": "2019-08-24",
                          "end": "2019-08-24"
                      }
                  ],
                  "requiredEmployeeIds": [
                      "string"
                  ],
                  "requiredStartTime": "14:15:22.123Z",
                  "lastWorkOrderDateForInterval": "2019-08-24"
              }
          ],
          "pinnedAssignments": [
              {
                  "workOrderId": "string",
                  "locationId": "string",
                  "employeeId": "string",
                  "start": "2019-08-24T14:15:22.123Z",
                  "end": "2019-08-24T14:15:22.123Z"
              }
          ],
          "holidays": [
              "2019-08-24"
          ]
      }'
      Response Response Example
      {
          "id": "string"
      }
      Modified at 2026-01-13 21:40:50
      Next
      Get the status of a planning request
      Built with