API Documentation
Dispatch and Routing
Location
Account Management
Place Management
Reports
Get Jobs
This endpoint retrieves jobs.
curl -X POST https://api.hellotracks.com/api/getjobs --header 'API-Key: ...' -d '
{
"data": {
"worker":"*",
"day": "20230813"
}
}
'
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}
Request
POST https://api.hellotracks.com/api/getjobs
{
data: {
id: "<id>",
ids: [ "<id1>", "<id2>", "<idn>" ],
day: 20231105,
worker: "<worker-username>",
team: <number> (optional),
orderId: <number> (optional),
orderIds: [<number1>,<number2>,...] (optional array of multiple orderIds),
progressSuccess: 1 (optional),
progressActive: 1 (optional)
}
}
Set this if you want to retrieve a specific job.
Use this field to retrieve multiple specific jobs.
day
is optional and defaults to today. To retrieve jobs with no date assigned, set day:0
.
To specifically ignore the day
field, set day:-1
.
To retrieve jobs that are not assigned to a worker, set worker:""
. To request all jobs for all workers for a specific date, set worker:"*"
.
team
is an optional filter to only request jobs for a specific team.
Optional filter to request a specific job.
Optional filter to request multiple specific jobs.
progressSuccess
is an optional filter to only retrieve jobs that are marked as successfully completed. For this, set the value to 1
, else set it either to 0
or do not set the field at all.
progressActive
is an optional filter to only retrieve jobs that are not marked as completed (neither success nor issue). For this, set the value to 1
, else set it either to 0
or do not set the field at all.
RESPONSE
{
status: 0,
jobs : [
{ <job_1> },
{ <job_2> },
...
{ <job_n> }
]
}
curl -X POST https://api.hellotracks.com/api/getjobs --header 'API-Key: ...' -d '
{
"data": {
"worker":"*",
"day": "20230813"
}
}
'
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}
curl -X POST https://api.hellotracks.com/api/getjobs --header 'API-Key: ...' -d '
{
"data": {
"worker":"*",
"day": "20230813"
}
}
'
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}