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

Equipment EquipmentCategory EquipmentFile EquipmentFormAlert EquipmentGeoData EquipmentMaintenanceEventReminder EquipmentMaintenanceEventType EquipmentMaintenanceLog EquipmentType TrackingDevice

Expenses

Expense ReceiptImage

Job Checklists

JobChecklist

Job Invoices

JobInvoice JobInvoiceTask

Jobs

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

Projects

ChangeOrderSnapshot

Purchase Orders

PurchaseOrder PurchaseOrderFile

Safety

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

SafetyForm Resource
In Safety Module

Endpoints

Endpoints URI Access Control Description
delete POST /api/SafetyForm/delete Admin or Module WRITE
save POST /api/SafetyForm/save Admin or Module WRITE
save-batch POST /api/SafetyForm/save-batch Admin or Module WRITE
get GET /api/SafetyForm/get Allowed with an active employment connection
find GET /api/SafetyForm/find Allowed with an active employment connection
get-estimated-drive-time GET /api/SafetyForm/get-estimated-drive-time Endpoint level permissions
notify-customer-eta GET /api/SafetyForm/notify-customer-eta Endpoint level permissions

Properties

Property Type Description
id number
slug string
category_id number
job_id number
template_id number
expiry datetime
form_json string
description string
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) None
Default Sort Order updated_at DESC

Relationships

Related Resource Key Relationship to SafetyForm Property
Job job_id Owns Many Job
Service service_id Owns Many Service
User updated_by Belongs To UpdatedBy
SafetyFormTemplate template_id Belongs To SafetyFormTemplate
SafetyFormAcknowledgement tailboard_id Owns Many SafetyFormAcknowledgement
SafetyFormCategory category_id Belongs To SafetyFormCategory