Skip to main content
POST
/
job
/
listJobs
List jobs
curl --request POST \
  --url https://ontime-api.masternautconnect.com/jobs/job/listJobs \
  --header 'Content-Type: application/json' \
  --header 'x-connect-token: <x-connect-token>' \
  --data '
{
  "groupName": "<string>",
  "scheduledStartDateTimeFrom": "<string>",
  "scheduledStartDateTimeTo": "<string>",
  "personId": "<string>",
  "personName": "<string>",
  "vehicleId": "<string>",
  "vehicleName": "<string>",
  "statuses": [
    "NEW"
  ],
  "jobTypeIds": [
    "<string>"
  ],
  "limit": 123,
  "nextToken": "<string>"
}
'
{
  "jobs": [
    {
      "jobId": "<string>",
      "jobNumber": "<string>",
      "jobTitle": "<string>",
      "clientName": "<string>",
      "accountNumber": "<string>",
      "contactName": "<string>",
      "contactEmail": "<string>",
      "contactPhone": "<string>",
      "notes": "<string>",
      "lat": 123,
      "lng": 123,
      "address": "<string>",
      "statusChangeTimestamp": "<string>",
      "statusChangeId": "<string>",
      "scheduledStartDateTime": "<string>",
      "jobDuration": "<string>",
      "arrivalWindowStart": "<string>",
      "arrivalWindowEnd": "<string>",
      "personId": "<string>",
      "vehicleId": "<string>",
      "groupName": "<string>",
      "personName": "<string>",
      "vehicleName": "<string>",
      "orderNumbers": [
        "<string>"
      ],
      "status": "NEW",
      "driverNotes": "<string>",
      "statusHistory": [
        {
          "date": "<string>",
          "personId": "<string>",
          "name": "<string>",
          "status": "NEW",
          "statusChangeId": "<string>"
        }
      ],
      "actualStart": "<string>",
      "actualEnd": "<string>",
      "overrideLat": 123,
      "overrideLng": 123,
      "jobHistory": [
        {
          "date": "<string>",
          "personId": "<string>",
          "name": "<string>",
          "assignedPersonName": "<string>",
          "assignedAssetName": "<string>"
        }
      ],
      "jobRadius": 123,
      "eta": "<string>",
      "etaDistanceKms": 123,
      "lastEtaCalcTime": "<string>",
      "primaryResource": "DRIVER",
      "jobTypeId": "<string>",
      "jobType": {
        "id": "<string>",
        "label": "<string>",
        "description": "<string>",
        "global": true,
        "used": true,
        "disabled": true,
        "key": "<string>",
        "earliestStartTime": 123,
        "latestStartTime": 123,
        "duration": "<string>",
        "notes": "<string>",
        "resources": [
          {
            "name": "<string>",
            "status": "NONE",
            "fileType": "<string>",
            "storageUrl": "<string>",
            "uploadUrl": "<string>",
            "presignedGetUrl": "<string>"
          }
        ],
        "sendJobReportOnCompletion": true,
        "workflowId": "<string>"
      },
      "jobPhotos": [
        {
          "date": "<string>",
          "downloadUrl": "<string>"
        }
      ],
      "jobSignature": {
        "date": "<string>",
        "downloadUrl": "<string>",
        "signeeName": "<string>"
      },
      "linkingId": "<string>",
      "linkedJobDescription": "<string>",
      "linkedJobIndex": "<string>",
      "resources": [
        {
          "name": "<string>",
          "status": "NONE",
          "fileType": "<string>",
          "storageUrl": "<string>",
          "uploadUrl": "<string>",
          "presignedGetUrl": "<string>"
        }
      ],
      "subStatus": {
        "key": "<string>",
        "value": "<string>"
      },
      "lastServerTime": "<string>",
      "visitResults": [
        {
          "jobScheduledStart": "<string>",
          "taskAnswers": [
            {
              "title": "<string>",
              "description": "<string>",
              "key": "<string>",
              "statusChangeId": "<string>",
              "timestamp": "<string>",
              "nextTaskKey": "<string>",
              "taskHandler": "TEXT_INFO_DISPLAY",
              "onTransitionTo": "<string>",
              "mandatory": true,
              "includeInReport": true,
              "value": {
                "stringValues": [
                  "<string>"
                ],
                "integerValue": 123,
                "doubleValue": 123,
                "blobValues": [
                  "<string>"
                ]
              },
              "onTransitionToLabel": "<string>",
              "personId": "<string>",
              "personName": "<string>"
            }
          ]
        }
      ],
      "subStatusLabel": "<string>",
      "statusLabel": "<string>"
    }
  ],
  "nextToken": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "count": 123
}

Headers

​
x-connect-token
string
required

Body

application/json
​
groupName
string

Name of a group. Must be specified if a value for either personName or vehicleName is not specified

​
scheduledStartDateTimeFrom
string

Start of the period of scheduled fulfilment date, in UTC, in the format of either YYYY-MM-DD or YYYY-MM-DDThh:mmZ.

​
scheduledStartDateTimeTo
string

End of the period of scheduled fulfilment date, in UTC, in the format of either YYYY-MM-DD or YYYY-MM-DDThh:mmZ.

​
personId
string

ID of the person

​
personName
string

Name of a driver that has been assigned a job. Must be specified if a value for either vehicleName or groupName is not specified.

​
vehicleId
string

ID of the vehicle

​
vehicleName
string

Name of a vehicle that has been assigned a job. Must be specified if a value for either personName or groupName is not specified.

​
statuses
enum<string>[]

Jobs with the specified status will be included in the response e.g. NEW, ASSIGNED, IN_PROGRESS, ACCEPTED, VISITED.

Status of the job. Allowed values are: [NEW, ASSIGNED, IN_PROGRESS, VISITED, CANCELLED].

Available options:
NEW,
ASSIGNED,
RECEIVED,
IN_PROGRESS,
VISITED,
CANCELLED,
MISSED,
ACCEPTED,
INCOMPLETE,
$UNKNOWN
​
jobTypeIds
string[]

Jobs with the specified job type will be included in the response.

​
limit
integer<int32>

The number of jobs to include in the output. If not specified, it will default to 20. Advise this is not set to greater than 1000 to avoid any issues with response size.

​
nextToken
string

Token returned in a previous call to this endpoint to get the next set of details.

Response

200 - application/json

listJobs 200 response

​
jobs
object[]
​
nextToken
string
​
errors
object[]
​
count
integer<int32>