Get Jobs

curl -X POST https://api.hellotracks.com/api/getjobs --header 'API-Key: ...' -d '
{
    "data": {
        "worker":"*",
        "day": "20230813"
    }
}
'

{
    "status": 0,
    "jobs": [
        {
            "id": "64d88ed519c0ae41096aa4b4",
            "day": 20251008,
            "number": 1,
            "type": 0,
            "priority": 5,
            "destinationName": "Acme Corp - Headquarters",
            "destinationText": "Main entrance, building A",
            "destinationLat": 37.7749,
            "destinationLng": -122.4194,
            "radius": 100,
            "contactName": "John Smith",
            "contactPhone": "+14155551234",
            "contactEmail": "john.smith@acme.com",
            "worker": "worker@company.com",
            "workerName": "Jane Doe",
            "workerEmail": "jane@company.com",
            "workerPhone": "+14155559876",
            "receiverUid": "abc123",
            "assigneeName": "Jane Doe",
            "assigneeUsername": "worker@company.com",
            "dispatcherName": "Dispatcher Mike",
            "dispatcherUid": "disp456",
            "textDispatcher": "Please deliver before 3 PM",
            "textReceiver": "Call customer on arrival",
            "itemsToPickup": 0,
            "itemsToDropoff": 3,
            "onSiteSeconds": 900,
            "windowStart": 800,
            "windowEnd": 1500,
            "tsCreated": 1696723200000,
            "tsSaved": 1696723245000,
            "tsAssigned": 1696723250000,
            "tsAccepted": 1696723300000,
            "tsScheduled": 1696748400000,
            "tsCheckIn": 1696752000000,
            "tsCheckOut": 1696752900000,
            "tsDoneSuccess": 1696752950000,
            "scheduledStart": 1696748400000,
            "scheduledEnd": 1696749300000,
            "orderId": 1012345,
            "fileNumber": "ORD-2024-1234",
            "uidSecondary": "EXT-9876",
            "labels": "urgent,vip",
            "carryOver": 0,
            "placeName": "Acme Corp HQ",
            "placeUid": "place789",
            "linkedForms": "delivery-form,signature-form",
            "linkedZones": "zone1,zone2",
            "teamId": 2,
            "confirmationEmails": "manager@acme.com,ops@acme.com",
            "customFields": [
                {"key": "PO_Number", "val": "PO-2024-5678"},
                {"key": "Department", "val": "Facilities"}
            ],
            "extra_number_1_key": "Weight (kg)",
            "extra_number_1_val": 45.5,
            "extra_text_1_key": "Special Instructions",
            "extra_text_1_val": "Fragile - Handle with care",
            "signatureName": "John Smith",
            "signatureSvg": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0...",
            "tsSignature": 1696752900000,
            "createdBy": "admin123",
            "createdVia": "api",
            "isTemplate": false,
            "jobType": "Delivery"
        }
    ]
}

POST

api

getjobs

curl -X POST https://api.hellotracks.com/api/getjobs --header 'API-Key: ...' -d '
{
    "data": {
        "worker":"*",
        "day": "20230813"
    }
}
'

{
    "status": 0,
    "jobs": [
        {
            "id": "64d88ed519c0ae41096aa4b4",
            "day": 20251008,
            "number": 1,
            "type": 0,
            "priority": 5,
            "destinationName": "Acme Corp - Headquarters",
            "destinationText": "Main entrance, building A",
            "destinationLat": 37.7749,
            "destinationLng": -122.4194,
            "radius": 100,
            "contactName": "John Smith",
            "contactPhone": "+14155551234",
            "contactEmail": "john.smith@acme.com",
            "worker": "worker@company.com",
            "workerName": "Jane Doe",
            "workerEmail": "jane@company.com",
            "workerPhone": "+14155559876",
            "receiverUid": "abc123",
            "assigneeName": "Jane Doe",
            "assigneeUsername": "worker@company.com",
            "dispatcherName": "Dispatcher Mike",
            "dispatcherUid": "disp456",
            "textDispatcher": "Please deliver before 3 PM",
            "textReceiver": "Call customer on arrival",
            "itemsToPickup": 0,
            "itemsToDropoff": 3,
            "onSiteSeconds": 900,
            "windowStart": 800,
            "windowEnd": 1500,
            "tsCreated": 1696723200000,
            "tsSaved": 1696723245000,
            "tsAssigned": 1696723250000,
            "tsAccepted": 1696723300000,
            "tsScheduled": 1696748400000,
            "tsCheckIn": 1696752000000,
            "tsCheckOut": 1696752900000,
            "tsDoneSuccess": 1696752950000,
            "scheduledStart": 1696748400000,
            "scheduledEnd": 1696749300000,
            "orderId": 1012345,
            "fileNumber": "ORD-2024-1234",
            "uidSecondary": "EXT-9876",
            "labels": "urgent,vip",
            "carryOver": 0,
            "placeName": "Acme Corp HQ",
            "placeUid": "place789",
            "linkedForms": "delivery-form,signature-form",
            "linkedZones": "zone1,zone2",
            "teamId": 2,
            "confirmationEmails": "manager@acme.com,ops@acme.com",
            "customFields": [
                {"key": "PO_Number", "val": "PO-2024-5678"},
                {"key": "Department", "val": "Facilities"}
            ],
            "extra_number_1_key": "Weight (kg)",
            "extra_number_1_val": 45.5,
            "extra_text_1_key": "Special Instructions",
            "extra_text_1_val": "Fragile - Handle with care",
            "signatureName": "John Smith",
            "signatureSvg": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0...",
            "tsSignature": 1696752900000,
            "createdBy": "admin123",
            "createdVia": "api",
            "isTemplate": false,
            "jobType": "Delivery"
        }
    ]
}

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),
		includeArchived: 1 (optional),
		compact: true (optional),
		sort: {
			field: "<field_name>",
			ascending: true/false,
			limit: <number>,
			skip: <number>,
			from: <timestamp>,
			until: <timestamp>,
			status: <number> (optional)
		} (optional)
	}
}

string

Set this if you want to retrieve a specific job.

array

Use this field to retrieve multiple specific jobs.

number

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.

string

To retrieve jobs that are not assigned to a worker, set worker:"". To request jobs assigned to any worker, set worker:"+". To request all jobs, assigned and unassigned, for a specific date, set worker:"*".

number

team is an optional filter to only request jobs for a specific team.

number

Optional filter to request a specific job.

array

Optional filter to request multiple specific jobs.

number

default:0

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.

number

default:0

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.

number

default:0

Set to 1 to include archived jobs in the results. Defaults to 0 (exclude archived jobs).

boolean

default:false

If set to true, returns jobs in compact format (less verbose response). Defaults to false for legacy requests.

object

Optional sorting and pagination configuration object with the following properties:

field (string): Field name to sort by (e.g., “tsCreated”, “priority”, “number”)
ascending (boolean): Sort direction - true for ascending, false for descending
limit (number): Maximum number of jobs to return
skip (number): Number of jobs to skip (for pagination)
from (long): Filter jobs from this timestamp (milliseconds)
until (long): Filter jobs until this timestamp (milliseconds)
status (number): Optional status filter (-1 for all)

When sort is provided, the day parameter defaults to undefined (all days) unless explicitly specified.

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"
    }
}
'

{
    "status": 0,
    "jobs": [
        {
            "id": "64d88ed519c0ae41096aa4b4",
            "day": 20251008,
            "number": 1,
            "type": 0,
            "priority": 5,
            "destinationName": "Acme Corp - Headquarters",
            "destinationText": "Main entrance, building A",
            "destinationLat": 37.7749,
            "destinationLng": -122.4194,
            "radius": 100,
            "contactName": "John Smith",
            "contactPhone": "+14155551234",
            "contactEmail": "john.smith@acme.com",
            "worker": "worker@company.com",
            "workerName": "Jane Doe",
            "workerEmail": "jane@company.com",
            "workerPhone": "+14155559876",
            "receiverUid": "abc123",
            "assigneeName": "Jane Doe",
            "assigneeUsername": "worker@company.com",
            "dispatcherName": "Dispatcher Mike",
            "dispatcherUid": "disp456",
            "textDispatcher": "Please deliver before 3 PM",
            "textReceiver": "Call customer on arrival",
            "itemsToPickup": 0,
            "itemsToDropoff": 3,
            "onSiteSeconds": 900,
            "windowStart": 800,
            "windowEnd": 1500,
            "tsCreated": 1696723200000,
            "tsSaved": 1696723245000,
            "tsAssigned": 1696723250000,
            "tsAccepted": 1696723300000,
            "tsScheduled": 1696748400000,
            "tsCheckIn": 1696752000000,
            "tsCheckOut": 1696752900000,
            "tsDoneSuccess": 1696752950000,
            "scheduledStart": 1696748400000,
            "scheduledEnd": 1696749300000,
            "orderId": 1012345,
            "fileNumber": "ORD-2024-1234",
            "uidSecondary": "EXT-9876",
            "labels": "urgent,vip",
            "carryOver": 0,
            "placeName": "Acme Corp HQ",
            "placeUid": "place789",
            "linkedForms": "delivery-form,signature-form",
            "linkedZones": "zone1,zone2",
            "teamId": 2,
            "confirmationEmails": "manager@acme.com,ops@acme.com",
            "customFields": [
                {"key": "PO_Number", "val": "PO-2024-5678"},
                {"key": "Department", "val": "Facilities"}
            ],
            "extra_number_1_key": "Weight (kg)",
            "extra_number_1_val": 45.5,
            "extra_text_1_key": "Special Instructions",
            "extra_text_1_val": "Fragile - Handle with care",
            "signatureName": "John Smith",
            "signatureSvg": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0...",
            "tsSignature": 1696752900000,
            "createdBy": "admin123",
            "createdVia": "api",
            "isTemplate": false,
            "jobType": "Delivery"
        }
    ]
}

API Documentation

Job Management

Dispatch and Routing

Location

Account Management

Place Management

Reports

No-Code Integrations

Request

RESPONSE

​Request

​RESPONSE

Request

RESPONSE