Schedule proposals

A preview of the tasks and routes a schedule will create over a date range.

A proposal is a preview: it reports the tasks and routes that the schedules would create over a date range, without creating any of them. It answers what next week looks like before next week arrives.

Every filter is optional. Leaving trackers, filter, from, or to out, or sending it as null, simply drops that condition rather than matching nothing.

API actions

API base path: /task/schedule/proposal.

Operations that list no errors of their own return only the general error codes.

If trackers, filter, from or to is not passed or null then appropriate condition not used to filter results.

---

List schedule proposals

post

/task/schedule/proposal/list

Preview the tasks and routes the schedules would create over a period. Creates nothing.

from should not be in the past, and to should not be before from.

A request with an empty body reports interval as the missing parameter. That is the internal name of the field holding both dates; the public parameters are from and to.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body

fromstringRequired

Show tasks that would be created after this date.

Example: 2026-08-24 09:00:00

tostringRequired

Show tasks that would be created before this date. Must be after from.

Example: 2026-08-24 09:00:00

trackersinteger[]Optional

Optional. IDs of the trackers the tasks would be assigned to.

filterstringOptional

Optional. Filter over schedule label and description.

Responses

200

The tasks and routes that would be created

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/task/schedule/proposal/list

POST /v2/task/schedule/proposal/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00",
  "trackers": [
    1
  ],
  "filter": "text",
  "types": [
    "task"
  ]
}

{
  "success": true,
  "list": [
    {
      "id": 1,
      "user_id": 1,
      "tracker_id": null,
      "location": {
        "lat": 1,
        "lng": 1,
        "address": "text",
        "radius": 1
      },
      "label": "text",
      "description": "text",
      "creation_date": "text",
      "from": "2026-08-24 09:00:00",
      "to": "2026-08-24 09:00:00",
      "external_id": null,
      "status": "unassigned",
      "status_change_date": "text",
      "max_delay": 1,
      "min_stay_duration": 1,
      "min_arrival_duration": 1,
      "arrival_date": null,
      "stay_duration": 1,
      "origin": "manual",
      "tags": [
        1
      ],
      "type": "task",
      "form": {
        "id": 1,
        "label": "text",
        "description": "text",
        "fields": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "created": "text",
        "submit_in_zone": true,
        "task_id": null,
        "checkin_id": null,
        "tracker_id": null,
        "template_id": null,
        "template_version": null,
        "values": null,
        "submitted": null,
        "submit_location": {
          "lat": 1,
          "lng": 1,
          "address": "text"
        }
      },
      "form_template_id": 1,
      "fields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "files": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ]
}