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

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

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

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

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

Contact Resource
In Contacts Module

Customers and suppliers (CRM contacts). Product language: Contacts, customers, suppliers. Locations on ContactLocation; files on ContactFile.

Endpoints

Endpoints URI Access Control Description
save POST /api/Contact/save Admin or Module WRITE
get GET /api/Contact/get Allowed with an active employment connection
find GET /api/Contact/find Admin or Module READ
merge-contacts POST /api/Contact/merge-contacts Endpoint level permissions Merge two contacts by moving all related records from source to destination and deleting the source @param array $input Must contain: - source_contact_id: ID of the contact to merge from (will be deleted) - destination_contact_id: ID of the contact to merge into (will be kept) - tenant_id: Required for validation @return array Success response or error messages
save-batch POST /api/Contact/save-batch Admin or Module WRITE
delete POST /api/Contact/delete Admin or Module WRITE

Properties

Property Type Description
id number
slug string
name string
is_company boolean
is_customer boolean
is_supplier boolean
company_type string
position string
phone string
email string
website string
suite string
address string
city string
province string
country string
postal_code string
lat number
long number
geocode_address_hash string
contact_id number
user_id number
settings_json string

Customer-specific billing/invoice settings as JSON (e.g. display and tax preferences). May be overridden on an invoice by ServiceInvoice.settings_override_json or similar document overrides.
charge_out_group_overrides_json string

Per-customer overrides of labour classification charge-out groups. JSON used when invoicing this customer so rates can differ from company defaults. Prefer parsing this over assuming global classification rates.
customer_onhold boolean
customer_onhold_reason string
notes string
message_thread_id number
qbo_id string
currency_code string
link_accepted boolean
link_denied boolean
created_at datetime
updated_at datetime
updated_by number

Settings

Setting
Pagination Limit (when page parameter is set) 50 per page
Default Sort Order name ASC

Relationships

Related Resource Key Relationship to Contact Property
Job customer_id Owns Many Job
Service customer_id Owns Many Service
ContactLocation contact_id Owns Many ContactLocation
Contact contact_id Belongs To Company
Contact contact_id Owns Many SubContacts
MessageThread message_thread_id Belongs To MessageThread
User email Belongs To UserLink
Company name Belongs To CompanyLink
CustomerAssetCategory asset_category_id Owns Many CustomerAssetCategory
CustomerAsset contact_id Owns Many CustomerAsset
User user_id Belongs To UserCustomer
ContactFile contact_id Owns Many ContactFile