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

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

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

User Resource
In Users Module

Employees and user accounts in the company. Product language: employees, team members, users. Count with get and count=true. User/get (tenant-scoped) rewrites filters onto nested User via CompanyUser; when using fields with filters, filter columns are retained for matching then stripped from the response. Prefer fields that include any columns you filter on if you need them in the result.

Endpoints

Endpoints URI Access Control Description
acknowledge-tos POST /api/User/acknowledge-tos Authentication only
test-notification POST /api/User/test-notification Authentication only
test-error GET /api/User/test-error Endpoint level permissions
register-notifications POST /api/User/register-notifications Authentication only
signup POST /api/User/signup Open

Creates a new user account.

Required parameters:

  • email: (string)

Optional parameters:

  • first_name
  • last_name
  • password
  • phone
  • phone_mobile
  • address
  • city
  • province
  • postal_code
terminate-user POST /api/User/terminate-user Endpoint level permissions Disconnects the user from the company. Requesting user must either be disconnecting themselves, or the user must have User module write permissions on the company in question
find GET /api/User/find Open
get-available GET /api/User/get-available Endpoint level permissions Get list of employees that are not scheduled on a service, or have an event scheduled TO-DO
get GET /api/User/get Admin or Module READ Get list of employees. Parameters also include 'includeFormer' (boolean), to include former employees. NOTE: Due to technical limitations, the filtering by included records is not available for the USER resource
public-search GET /api/User/public-search Endpoint level permissions Allows a search of ALL users, even outside of requesting user's company. Returns a set subset of the User record with attached ProfileImage, CompanyUser child models
save POST /api/User/save Admin or Module WRITE
invite POST /api/User/invite Endpoint level permissions Sends invitation to join TradeTraks or TradeTraks and company RequestType: POST
find-invited GET /api/User/find-invited Open Returns a user who has been invited to TradeTraks but not activated yet. Requires an unprotected endpoint
third-party-settings POST /api/User/third-party-settings Endpoint level permissions Endpoint to handle toggling of third party settings, like maillists for OCN & Databid
send-mfa-code POST /api/User/send-mfa-code Open
authenticate POST /api/User/authenticate Open
send-email-verification POST /api/User/send-email-verification Authentication only
reset-request POST /api/User/reset-request Open
reset-password POST /api/User/reset-password Open
change-password POST /api/User/change-password Endpoint level permissions
refresh-api-key POST /api/User/refresh-api-key Endpoint level permissions

Properties

Property Type Description
id number
slug string
first_name string
last_name string
email string
phone string
phone_mobile string
address string
city string
province string
country string
postal_code string
job_title string
emergency_contact_name string
emergency_contact_phone string
emergency_contact_address string
emergency_contact_relationship string
birthdate date
description string
image_id number
send_message_emails boolean
send_marketing_emails boolean
send_service_request_emails boolean
editing_locked boolean
one_signal_user_id string
has_push_notification_devices boolean
public_phone boolean
public_email boolean
is_looking_for_work boolean
last_login datetime
last_active_domain string
last_active datetime
invite_accepted boolean
clocked_in boolean
widget_settings_json string
created_by number
created_at datetime
invited_by number
admin_lockout boolean
channel_partner_id boolean
email_verified string
zendesk_user_id string

Settings

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

Relationships

Related Resource Key Relationship to User Property
UserToken user_id Owns Many Tokens
UserPermission user_id Owns Many UserPermission
CompanyUser user_id Owns Many CompanyUser
ProfileImage image_id Belongs To ProfileImage
EmployeeSetting user_id Owns Many EmployeeSetting
EmployeeClassification classification_id Owns Many EmployeeClassification
OpenTimeLog user_id Owns Many OpenTimeLog
JobPersonnelRole personnel_role_id Owns Many ServiceJobPersonnelRole
JobPersonnelRole personnel_role_id Owns Many JobPersonnelRole
Job job_id Owns Many Job
Service service_id Owns Many Service
ServiceContract service_contract_id Owns Many ServiceContract
Service assigned_to Owns Many AssignedServices
WorkHistory user_id Owns Many WorkHistory
UserCertificate user_id Owns Many UserCertificate
UserEvent user_id Owns Many UserEvent
Contact email Belongs To ContactLink