API Documentation

Modules

Calendar

Event

Certificates

CompanyCertificate UserCertificate UserCompanyCertificate

CollectiveAgreements

CollectiveAgreement

Company Forms

CompanyForm CompanyFormAcknowledgement CompanyFormRecurring FormMarketplaceCategory FormMarketplaceTemplate FormShareGroup

Company Forms Management

FormChildTemplate FormTemplate FormTemplateCategory

Contacts

Contact ContactFile ContactLocation

Contracts

ServiceContract ServiceContractFile ServiceContractProduct ServiceContractTask ServiceProduct

Customer Assets

AssetMaintenanceLog CustomerAsset CustomerAssetCategory CustomerAssetFile CustomerAssetTemplate CustomerAssetTemplateCategory UserAsset UserAssetCategory

Equipment

Expenses

Expense ReceiptImage

Job Checklists

JobChecklist

Job Invoices

JobInvoice JobInvoiceTask

Jobs

ChangeOrderSnapshot ChangeWorksheet Job JobActualCostDatapoint JobBid JobBidComponent JobBidComponentObject JobChangeOrder JobChangeOrderObject JobContact JobEstimate JobFile JobNote JobReport JobTask JobUser

Labour Actions

LabourAction LabourActionCategory

Library

LibraryFile

Locates

Locate LocateTicket

Materials

AssemblyTag Material MaterialAssembly MaterialAssemblyItem MaterialCategory

Messages

Message MessageThread MessageThreadUser

Purchase Orders

PurchaseOrder PurchaseOrderFile

Safety

SafetyControl SafetyForm SafetyFormTemplate SafetyHazard SafetyHazardCategory SafetyJobTask

Schedule

ScheduleEvent ScheduleLog

Service Quotes/Invoices

ServiceInvoice ServiceInvoiceObject ServiceQuoteTemplate ServiceQuoteTemplateObject

Service Requests

ServiceRequest

Services

Service ServiceContact ServiceFile ServiceSnapshot ServiceUser ServiceWorksheet ServiceWorksheetImage

Settings

AddonApp AddonAppInstalled Category ClassificationGroup CompanyAddress CompanySetting EmployeeClassification ExpenseCode ExpenseGroup FileTag JobFileTag PayBoost PermissionTemplate RevenueCode TimeLogSetting Union

TimeLogs

OpenTimeLog PayPeriod PayPeriodUserReport PendingOvertimeTransfer TimeLog TimeLogDetailedClaim

Users

EmployeeSetting LibraryAcknowledgement User UserLocation WorkHistory

Other

Activity BusinessType CertificateUpload Checklist Company CompanyCustomer CompanyLink CompanyUser DrawCanvas EmailList Engagement ErrorLog FileShareGroup ImageDrawLayer JobPersonnelRole JobSector KnowledgeBaseArticle KnowledgeBaseCategory LibraryUpload Module Notification NotificationQueue Product ProfileImage Proxy QuickbooksConnection Redirect ReleaseNote SharedDocument Subscription UploadFile UploadImage UserPermission UserToken Weather

Equipment Resource
In Equipment Module

Endpoints

Endpoints URI Access Control Description
get GET /api/Equipment/get Admin or Module READ
delete POST /api/Equipment/delete Admin or Module WRITE
save POST /api/Equipment/save Admin or Module WRITE
remove-tracking-device POST /api/Equipment/remove-tracking-device Endpoint level permissions

Disconnects the fleet tracking device from a piece of equipment. The equipment will no longer report location or status.

Required parameters:

  • id: (int) ID of the equipment

Errors: Returns an array with a message if id is missing or the equipment is not found.
get-geo-data GET /api/Equipment/get-geo-data Endpoint level permissions

Returns live location and status for a single piece of equipment that has a fleet tracking device.

Required parameters:

  • slug or id: Equipment identifier

Errors: Returns an array with a message if slug/id is missing, equipment is not found, the equipment has no tracking device, or the device is offline.
poll-location GET /api/Equipment/poll-location Endpoint level permissions

Returns current location and status for a tracking device by its geotab_entity_id. Use this for frequent polling (e.g. live map updates) when you already have the device ID.

Required parameters:

  • geotab_entity_id: (string) Tracking device ID

Errors: Returns an array with a message if geotab_entity_id is missing.
get-fleet-geo-data GET /api/Equipment/get-fleet-geo-data Endpoint level permissions

Returns live location and status for all equipment in your company that have fleet tracking devices.

Parameters: None required. Company context is determined by your authentication.
find GET /api/Equipment/find Admin or Module READ
report GET /api/Equipment/report Endpoint level permissions
save-batch POST /api/Equipment/save-batch Admin or Module WRITE

Properties

Property Type Description
id number
slug string
type_id number
description string
serial_num string
date_acquired date
charge_out_rate number
next_service_date date
next_service_description string
next_service_mileage_or_time number
last_service_date date
last_service_mileage_or_time number
last_service_description string
parts_json string
custom_fields_json string
location_type string
address string
suite string
city string
province string
country string
postal_code string
lat number
long number
message_thread_id number
color_hex string
geotab_entity_id string
assigned_user_id number
archived boolean
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order description ASC

Relationships

Related Resource Key Relationship to Equipment Property
EquipmentType type_id Belongs To EquipmentType
EquipmentMaintenanceLog equipment_slug Owns Many EquipmentMaintenanceLog
MessageThread message_thread_id Belongs To MessageThread
EquipmentFile equipment_id Owns Many EquipmentFile
User assigned_user_id Belongs To UserAssignedTo