Skip to main content
{
    "assigneeName":"David Miller",
    "assigneeUsername":"test.topservices",
    "carryOver":1,
    "contactEmail":"",
    "contactName":"",
    "contactPhone":"",
    "confirmationEmails":"",
    "customFields":[],
    "day":20230813,
    "destinationLat":37.785967,
    "destinationLng":-122.414136,
    "destinationName":"Pickup at Matteo",
    "destinationText":"Matteo",
    "dispatcherName":"",
    "dispatcherUid":"",
    "dispatcherUrl":"",
    "extra_number_1_key":"This is for number",
    "extra_number_1_val":0,
    "extra_number_2_key":"This is for checkbox",
    "extra_number_2_val":0,
    "extra_number_3_key":"This is for number 2",
    "extra_number_3_val":0,
    "extra_number_4_key":"This is for checkbox 2",
    "extra_number_4_val":0,
    "extra_number_types":"{\"2\":\"bool\",\"4\":\"bool\",\"6\":\"bool\",\"7\":\"bool\"}",
    "extra_text_1_key":"This is for text",
    "extra_text_1_val":"",
    "extra_text_2_key":"This is for decimal",
    "extra_text_2_val":"",
    "extra_text_3_key":"This is for text 2",
    "extra_text_3_val":"",
    "extra_text_4_key":"This is for decimal 2",
    "extra_text_4_val":"",
    "extra_text_types":"{\"2\":\"decimal\",\"4\":\"decimal\",\"6\":\"decimal\"}",
    "id":"64d800e5a3d05d0db096f939",
    "inputFormConfig":"",
    "itemsToDropoff":0,
    "itemsToPickup":0,
    "label":"",
    "linkedForms":"",
    "linkedZones":"",
    "manualChecks":"",
    "number":1,
    "onSiteSeconds":720,
    "orderId":0,
    "placeName":"Pickup at Matteo",
    "placeUid":"h4863l",
    "placeUrl":"https://hellotracks.com/img/accounts/h4863l/portrait_1681311626037_thumb.jpg",
    "priority":5,
    "radius":100,
    "receiverUid":"c0s1xv",
    "scheduledEnd":0,
    "scheduledStart":0,
    "signatureName":"",
    "signaturePdf":"",
    "signatureSvg":"",
    "submittedForms":"",
    "teamId":0,
    "textDispatcher":"",
    "textReceiver":"",
    "tsAccepted":0,
    "tsAssigned":0,
    "tsCheckIn":0,
    "tsCheckNFC1":0,
    "tsCheckNFC2":0,
    "tsCheckOut":0,
    "tsCreated":1691877605307,
    "tsDoneFailed":0,
    "tsDoneSuccess":0,
    "tsRejected":0,
    "tsSaved":1691877605307,
    "tsScheduled":0,
    "tsSignature":0,
    "type":1,
    "url_1":"https://goo.gl/forms/BdY3Cfi1yVVcvwYE3",
    "url_2":"https://google.com",
    "windowEnd":2400,
    "windowStart":0,
    "worker":"test.topservices",
    "workerEmail":"mario+test.topservices@hellotracks.com",
    "workerName":"David Miller",
    "workerPhone":""
}

Job API Object

PropertyTypeR/WDescription
idTEXTRJob unique ID
uidSecondaryTEXTRWSecondary unique identifier (custom external ID)
typeINTRWJob Type: 0=Work, 1=Pickup, 2=Dropoff
teamIdINTRWTeam Id 0-n (the number of the team). Defaults to 0 (no specific team).
destinationNameTEXTRWTitle of this job (1-line description)
destinationLatDOUBLERWLatitude
destinationLngDOUBLERWLongitude
destinationTextTEXTRWLocation Address
destinationUrlTEXTRLocation map URL
textDispatcherTEXTRWDispatcher additional info text (multi-line). Can also use notes field.
notesTEXTRWAlias for textDispatcher - dispatcher notes/instructions
textReceiverTEXTRWWorker’s reply text
contactNameTEXTRWName of contact at job’s location
contactPhoneTEXTRWPhone number of contact at job’s location
contactEmailTEXTRWEmail of contact at job’s location
fileNumberTEXTRWFile number or reference code
dayINTRWDate for job as YYYYMMDD or 0 (e.g. 20150530)
priorityINTRWPriority min:0-max:10
numberINTRWSequence number for ordering
onSiteSecondsINTRWThe assumed onsite-time in seconds (e.g. 10min on site: 600)
windowStartINTRWFormat: HHMM or 0 (e.g 704 = 7:04am)
windowEndINTRWFormat: HHMM or 0 (e.g 1724 = 5:24pm)
orderIdLONGRWOptional Order ID as a long integer number
dispatcherUidTEXTRWUID of dispatcher account
dispatcherNameTEXTRName of Dispatcher
dispatcherUrlTEXTRURL for dispatcher icon image
placeUidTEXTRWUID of place to visit or ""
placeNameTEXTRName of place/location
placeUrlTEXTRURL for place icon image
radiusINTRRadius for check-in/out in meter (place-radius or default-radius)
workerTEXTRWUser name of assigned worker
receiverUidTEXTRWUID of assigned worker (alternative to worker)
workerNameTEXTRFull name of assigned worker
workerEmailTEXTREmail address of assigned worker
workerPhoneTEXTRPhone number of assigned worker
assigneeNameTEXTRLegacy alias for workerName (deprecated, use workerName)
assigneeUsernameTEXTRLegacy alias for worker (deprecated, use worker)
itemsToDropoffINTRWNumber of items to drop off
itemsToPickupINTRWNumber of items to pick up
carryOverINTRWDays left to carry over (use 1 for default carry-over days)
labelsTEXTRWComma-separated labels for categorization
zipcodeINTRWZip/postal code for the job location
statusTEXTRSet to archived if job is archived, omitted otherwise

Job Status attributes (progress)

The job status attributes hold the timestamp when an event has occurred or 0 if it does not apply. Note: Timestamps are milliseconds, between the current time and midnight, January 1, 1970 UTC (Java timestamps) E.g.: 1430580377000 = Sat, 02 May 2015 15:26:17 GMT
PropertyTypeR/WDescription
tsCreatedLONGRWTimestamp in millis for job creation
tsSavedLONGRTimestamp in millis when job was last saved
tsAssignedLONGRTimestamp in millis for job assigned to worker
tsAcceptedLONGRWTimestamp in millis for job accepted by worker
tsRejectedLONGRWTimestamp in millis for job rejected by worker
tsScheduledLONGRWTimestamp in millis for job scheduled
tsDoneSuccessLONGRWTimestamp in millis for job marked as success by worker
tsDoneFailedLONGRWTimestamp in millis for job marked as issue by worker
tsCheckInLONGRWTimestamp in millis for auto check-in by worker
tsCheckOutLONGRWTimestamp in millis for auto check-out by worker
tsCheckNFC1LONGRTimestamp in millis for first check with NFC
tsCheckNFC2LONGRTimestamp in millis for second check with NFC
tsTripStartedLONGRTimestamp in millis when trip to job location started
tsSignatureLONGRWTimestamp in millis when signature was captured

Scheduling & Windows:

PropertyTypeR/WDescription
scheduledStartINTRScheduled start time calculated by route optimizer
scheduledEndINTRScheduled end time calculated by route optimizer

Signature & Digital Forms:

PropertyTypeR/WDescription
signatureNameTEXTRWName of person who signed
signatureSvgTEXTRWSVG data for signature (clears signaturePdf)
signaturePdfTEXTRWPDF data for signature (clears signatureSvg)
keymapTEXTRWKey mapping configuration
manualChecksTEXTRWManual check data
linkedZonesTEXTRWLinked zone IDs
linkedFormsTEXTRWLinked form IDs
submittedFormsTEXTRSubmitted form data (read-only)
inputFormConfigTEXTRWInput form configuration
formConfigTEXTRComplete form configuration (compact mode only)
confirmationEmailsTEXTRWConfirmation email addresses
commentsTEXTRWJob comments data
associatedJobIdTEXTRWAssociated job identifier
requiredSkillsTEXTRWRequired skills for this job
requiredEquipmentTEXTRWRequired equipment for this job

History & Tracking:

PropertyTypeR/WDescription
createdByTEXTRUID of user who created this job
createdViaTEXTRSource of job creation (web, mobile, api)
assigneeHistoryTEXTRHistory of worker assignments
progressStatusHistoryTEXTRHistory of status changes
tripIdTEXTRAssociated trip identifier

Template & Sequence Metadata:

PropertyTypeR/WDescription
isTemplateBOOLEANRTrue if this is a job template
isPartOfSequenceBOOLEANRTrue if job belongs to a sequence
sequenceIdTEXTRID of the sequence this job belongs to
jobTypeTEXTRHuman-readable job type name

Customizable Attributes:

PropertyTypeR/WDescription
custom_$TEXTRWCustom field where $ is the desired field name
customFieldsARRAYRWArray of custom field key-value pairs
extra_number_$_keyTEXTRWorker input number field label where $ is 1-10
extra_number_$_valINTRWWorker input number value where $ is 1-10
extra_text_$_keyTEXTRWorker input text field label where $ is 1-20
extra_text_$_valTEXTRWWorker input text value where $ is 1-20
extra_number_typesTEXTRJSON metadata describing number field types
extra_text_typesTEXTRJSON metadata describing text field types
url_$TEXTRWURL field where $ is 1-n (multiple URLs supported)
Note on Form Fields:
  • Field labels (extra_number__key, extra_text__key) are read-only and configured via inputFormConfig
  • If a field name starts with *, it indicates a required field
  • Types metadata contains JSON like {"2":"bool","4":"decimal"} to specify special input types
  • Supported types: bool (checkbox), decimal, number (default), text (default)
{
    "assigneeName":"David Miller",
    "assigneeUsername":"test.topservices",
    "carryOver":1,
    "contactEmail":"",
    "contactName":"",
    "contactPhone":"",
    "confirmationEmails":"",
    "customFields":[],
    "day":20230813,
    "destinationLat":37.785967,
    "destinationLng":-122.414136,
    "destinationName":"Pickup at Matteo",
    "destinationText":"Matteo",
    "dispatcherName":"",
    "dispatcherUid":"",
    "dispatcherUrl":"",
    "extra_number_1_key":"This is for number",
    "extra_number_1_val":0,
    "extra_number_2_key":"This is for checkbox",
    "extra_number_2_val":0,
    "extra_number_3_key":"This is for number 2",
    "extra_number_3_val":0,
    "extra_number_4_key":"This is for checkbox 2",
    "extra_number_4_val":0,
    "extra_number_types":"{\"2\":\"bool\",\"4\":\"bool\",\"6\":\"bool\",\"7\":\"bool\"}",
    "extra_text_1_key":"This is for text",
    "extra_text_1_val":"",
    "extra_text_2_key":"This is for decimal",
    "extra_text_2_val":"",
    "extra_text_3_key":"This is for text 2",
    "extra_text_3_val":"",
    "extra_text_4_key":"This is for decimal 2",
    "extra_text_4_val":"",
    "extra_text_types":"{\"2\":\"decimal\",\"4\":\"decimal\",\"6\":\"decimal\"}",
    "id":"64d800e5a3d05d0db096f939",
    "inputFormConfig":"",
    "itemsToDropoff":0,
    "itemsToPickup":0,
    "label":"",
    "linkedForms":"",
    "linkedZones":"",
    "manualChecks":"",
    "number":1,
    "onSiteSeconds":720,
    "orderId":0,
    "placeName":"Pickup at Matteo",
    "placeUid":"h4863l",
    "placeUrl":"https://hellotracks.com/img/accounts/h4863l/portrait_1681311626037_thumb.jpg",
    "priority":5,
    "radius":100,
    "receiverUid":"c0s1xv",
    "scheduledEnd":0,
    "scheduledStart":0,
    "signatureName":"",
    "signaturePdf":"",
    "signatureSvg":"",
    "submittedForms":"",
    "teamId":0,
    "textDispatcher":"",
    "textReceiver":"",
    "tsAccepted":0,
    "tsAssigned":0,
    "tsCheckIn":0,
    "tsCheckNFC1":0,
    "tsCheckNFC2":0,
    "tsCheckOut":0,
    "tsCreated":1691877605307,
    "tsDoneFailed":0,
    "tsDoneSuccess":0,
    "tsRejected":0,
    "tsSaved":1691877605307,
    "tsScheduled":0,
    "tsSignature":0,
    "type":1,
    "url_1":"https://goo.gl/forms/BdY3Cfi1yVVcvwYE3",
    "url_2":"https://google.com",
    "windowEnd":2400,
    "windowStart":0,
    "worker":"test.topservices",
    "workerEmail":"mario+test.topservices@hellotracks.com",
    "workerName":"David Miller",
    "workerPhone":""
}
I