Overview of API Entity Families/Groupings

We have more than a 100 endpoints organized into several categories. While not an exhaustive list, the below are very valuable. For the full list, you add the path /rest/v1 to the end of your TrackTik portal's domain, or refer to https://partnerships.staffr.net/rest/v1.

Asset Management

assets
asset-custom-fields
asset-fieldset-fields
asset-fieldsets
asset-manufacturers
asset-suppliers
asset-types

Asset Tracking

asset-categories
asset-contacts
asset-custom-attributes
asset-files
asset-manufacturers
asset-persons
asset-reservations
asset-suppliers
asset-transaction-items
asset-transactions
asset-type-custom-attributes
asset-type-files
asset-type-to-report-template-assignment
asset-types
assets

BOSS HR+Scheduling

break-rule-compliance-logs
break-rule-conditions
break-rule-exceptions
break-rule-relations
break-rules
break-sessions
calendar-exceptions
shifts
shift-logs
shift-notes
shift_proposal_queue_items
shift-template-settings
shift-templates
entity-label-availability-types
entity-labels
open-shift-requests
overtime-rule-items
overtime-rules
lone-worker-check-in-logs
lone-worker-check-ins
lone-worker-phone-calls
lone-worker-phones
lone-worker-schedule-check-ins
lone-worker-time-keeping-settings
phone-call-logs
schedule-off-periods
sms-logs
work_sessions

BOSS Payroll

payroll-payruns
payroll-schedules
payroll-payrun_items
payroll-adhocs
payroll-deductions
payroll-codes
payroll-schedules
employee-bill-pay-matrix-rate-settings
employee-class-pay-settings
employee-classes
employee-pay-settings
employee-premium-assignments
position-bill-settings
position-billing-settings
position-expense-reimbursements
position-pay-settings
position-payroll-settings
position-premium-assignments
position-premiums
position-price-matrix-rules

BOSS Contracts, Invoicing, Payroll

back-office-pay-settings
back-office-settings
client-billing-settings
client-invoice-split-settings
contracts
contract-service-models
contract-occurrence-logs
contract-recurrent-fixed-services
contract-service-models
billing-addresses
billable-items
bill-items
billing-adhoc-items
invoices
invoice-line-taxes
invoice-lines
payment-methods
payments
task_price_tiers
tax-class-items
tax-classes
tax-location-override-groups

Core

accounts
addresses
app-licenses
audit-logs
clients
client-users
checkpoint-question_answers
checkpoint-scans
checkpoint-tour_assignments
checkpoint-tour_schedules
checkpoint-tour_session_comments
checkpoint-tour_sessions
checkpoint-tours
checkpoints
comments
contacts
departments
emergency-contacts
emergency-contact-account-assignments
employee-account-assignment-pay-settings
employee_account_assignments
employee-account-bans
employee-availabilities
employee_extra_regions
employees
employee-skills
employee-seniorities
employee-external-id-fields
employee-external-ids
employee-extra-regions
employment-profiles
employment-termination-reasons
event-activities
events-subscription-logs
events-subscriptions
filter-rule-set-assets
filter-rule-set-reports
filter-rule-sets
geo-countries
geo-country-subdivisions
geo-fences
geo-locations
holiday-groups
holidays
message-board-post-acknowledgements
message-board-post-recipients
message-board-post-categories
message-board-posts
mobile-device-geo-locations
mobile-devices
model-translations
position-skills
positions
post-order-acknowledgements
post-order-subjects
post-orders
positions
regions
report-flag-categories
reports
report-fields
report-template-fields
report-templates
report-flags
report-flag-group-assignments
report-flag-groups
report-flag-template-fields
report-flag-templates
roles
role-permissions
site-locations
vehicles
skills
skill-categories
system-usage-logs
tenants
units
user-login-logs
user-roles
user-notification-settings
zone-clients
zones

Leave Management

leave-accruals
leave-policies
leave-policy-balances
leave-policy-carry-over-logs
leave-policy-items
leave-request-logs
leave-request-vacated-shifts
leave-requests
leave-types

Mobile Dispatch

alarms
alarm-connections
alarm organizations
alarm-types
dispatch-custom-locations
dispatch-slas
dispatch-sla-timer-settings
dispatch-tasks
dispatch-tasks-notes
dispatch-slas
task-types
task-type-skills
task-site-instructions
task-site-settings
workflow-instance-logs
workflow-instances
workflows
workflow-status-actions
workflow-status-transition-forms
workflow-status-transitions
workflow-statuses
workflow-timers

Mobile Patrol

mobile-runsheet-sessions
mobile-schedule-occurrence_logs
mobile-runsheet-sessions-logs
mobile-schedules
mobile-runsheets
mobile-schedule-occurrence-logs-notes
mobile-schedule-occurrencereassignments
system-exception-ticket-instructions
system-exception-tickets

NOTE

There are others available behind special features and web portal configurations. For more information on those see this article: https://support.tracktik.com/hc/en-us/articles/30000321740055-API-Endpoints-Behind-Feature-Enablements-and-Portal-Configurations

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more