API Families Overview
The PAR OPS Back Office platform exposes a large number of endpoint groups across the v1, v2+, and ShiftWorks APIs. This page groups them by logical function so you can quickly find the right endpoint group for your use case, before diving into the full API References.
-
Account & Identity (
v1,v2+) - Login, session, and identity management for users and integrations.Account,AuthConfig,OAuth,ParIdentity,User,StoreUsers,Partner. -
Scheduling & Labor (
v1,v2+,ShiftWorks) - Building schedules, shifts, trades, availability, and time off across single or multi-store setups.Schedule,Scheduling,Shifts,Trades,EmployeeShifts,StoreSchedule*,MultiStoreSchedule*,ScheduleTemplates,Availabilities,Swaps,StoreTimeOff. -
Time & Attendance (
v2+,ShiftWorks) - Clocking in/out, timecards, and payroll-adjacent time tracking.TimeClock,TimeCard,COGsShifts. -
Payroll & Compliance (
v1,v2+) - Payroll processing/export, tax forms, and labor compliance.Payroll,PayrollExport,PayrollJobs,ProcessPayroll,ProcessPayrollUnit,StorePayroll,W4Form,PayMemoTransaction,HRIntegration,Autocompliance,Certification. -
Point of Sale (POS) & Sales (
v1,v2+) - POS configuration, modifiers, and sales/order data.POS,POSModifier,POSModifierDynamic,POSModifierIF,POSDataSourceSetup,POSQFactors,SalesOrder,Vouchers. -
Inventory, Purchasing & Vendors (
v1,v2+) - Item catalogs, counts, waste, prep, purchasing, and vendor management.Items,StoreItems,VendorItems,Vendors,StoreVendors,PurchaseManagement,Counts,CountTemplates,FreezerPullItems,PreparedItems,PrepSheetItems,Waste,ButcherBatches,Labels. -
Checklists, Line Checks & Tasks (
v1,v2+) - Operational task lists and food-safety/line-check workflows.Checklists,StoreChecklists,LineChecks,LineCheckTasks,LineCheckTemplates,ToDos. -
Forecasting & Reporting (
v1,v2+) - Sales/labor forecasting, analytics, and financial reporting/exports.Forecast,EventForecast,StoreEventForecast,Reports,Metrics,ChartOfAccounts,QuickBooks,QBExport. -
Store & Organization Settings (
v1,v2+) - Store metadata, global configuration, locale, and feature management.Stores,Settings,GlobalSettings,Country,Currencies,TimeZone,AdminUnitOpenHours,StoreUnitOpenHours,CustomField,FeatureToggles,SubscriptionGroups,SubscriptionTypes. -
Rules & Approvals (
v2+) - Configurable business rules and approval routing.Rules,RuleActivity,RuleApprovers,RuleConditions,RuleGroups. -
Communication & Notifications (
v1,v2+,ShiftWorks) - In-app messaging, broadcasts, activity feeds, and help content.Broadcast,ActivityFeed,ActivityFeedSetup,ActivityMenu,EmployeeNotifications,ManagerLog,ScheduleChat,Chats,HelpHub,Help,UIEvents,Concierge. -
Employee Self-Service (ShiftWorks) (
ShiftWorks) - Employee-facing scheduling app: viewing/trading shifts, availability, and contact info.Shifts,Swaps,Availabilities,Requests,TimeClock,ContactInfo,EmailChange.
How to use this list
- Find the entry that matches what you are trying to build (e.g., "I need to pull sales data" → Point of Sale (POS) & Sales).
- Note which API(s) contain it — most operational data lives in v2+; use v1 only if you have an existing integration built against it.
- Open the matching endpoint group(s) in the API References section for full request/response details.
If you are not sure which group covers your use case, contact the PAR OPS support team — endpoint groups occasionally overlap or evolve between v1 and v2+.
