Jump to Content
Documentation
API Specifications
What's New
UKG.com
Marketplace
UKG Pro status
Log In
API Specifications
What's New
UKG.com
Marketplace
UKG Pro status
Log In
Documentation
API Specifications
Create Customer
JUMP TO
Welcome
Welcome to the UKG Pro Workforce Management API
Activities
Active Team Members
Retrieve Active Team Members
post
Activity
Retrieve Activity by Name
get
Create Activity
post
Retrieve Activity Export Definitions
post
Create Activities
post
Delete Activities
post
Retrieve Activities
post
Update Activities
post
Create or Update Activities
post
Delete Activity by ID
delete
Retrieve Activity by ID
get
Update Activity by ID
put
Activity Actions
Retrieve All Activity Actions or by Name
get
Create Activity Action
post
Create Activity Actions
post
Delete Activity Actions
post
Retrieve Activity Actions
post
Update Activity Actions
post
Delete Activity Action by ID
delete
Retrieve Activity Action by ID
get
Update Activity Action by ID
put
Activity Assignments
Retrieve Activities for Multiple Employees
post
Activity Customers
Retrieve All Customers or by Name
get
Create Customer
post
Create Customers
post
Delete Customers
post
Retrieve Customers
post
Update Customers
post
Delete Customer by ID
delete
Retrieve Customer by ID
get
Update Customer by ID
put
Activity Efficiencies
Retrieve Activity Efficiencies
post
Activity Form Profiles
Retrieve All Form Profiles or by Name
get
Create Form Profile
post
Create Form Profiles
post
Delete Form Profiles
post
Retrieve Form Profiles
post
Update Form Profiles
post
Delete Form Profile by ID
delete
Retrieve Form Profile by ID
get
Update Form Profile by ID
put
Activity Form Resources
Retrieve All Control Types or Only Applicable Type
get
Retrieve All Entry Types
get
Retrieve All Form Types
get
Retrieve All Input Source Types
get
Retrieve Offline Forms
get
Retrieve All Validation Types
get
Activity Forms
Retrieve All Activity Forms or by Name
get
Create Activity Form
post
Create Activity Forms
post
Delete Activity Forms
post
Retrieve Activity Forms
post
Update Activity Forms
post
Delete Activity Form by ID
delete
Retrieve Activity Form by ID
get
Update Activity Form by ID
put
Activity Historical Net Changes
Retrieve Historical Net Changes for Activity Shifts
post
Activity Move Quantity Transaction Audits
Retrieve Activity Move Quantity Transaction Audits
post
Activity Net Changes
Retrieve Net Changes for Activity Shifts
post
Activity Profile Resources
Retrieve Future Validation Types
get
Retrieve Tracking Status Types
get
Retrieve Variance Check Types
get
Retrieve Work Rules for Activities
get
Activity Profiles
Retrieve All Activity Profiles or by Name
get
Create Activity Profile
post
Create Activity Profiles
post
Delete Activity Profiles
post
Retrieve Activity Profiles
post
Update Activity Profiles
post
Delete Activity Profile by ID
delete
Retrieve Activity Profile by ID
get
Update Activity Profile by ID
put
Activity Queries
Retrieve All Activity Queries or by Name
get
Create Activity Query
post
Create Activity Queries
post
Delete Activity Queries
post
Retrieve Activity Queries
post
Update Activity Queries
post
Delete Activity Query by ID
delete
Retrieve Activity Query by ID
get
Update Activity Query by ID
put
Activity Query Profiles
Retrieve All Activity Query Profiles by Name
get
Create Activity Query Profile
post
Create Activity Query Profiles
post
Delete Activity Query Profiles
post
Retrieve Activity Query Profiles
post
Update Activity Query Profiles
post
Delete Activity Query Profile by ID
delete
Retrieve Activity Query Profile by ID
get
Update Activity Query Profile by ID
put
Activity Query Resources
Retrieve All Activity Query Date Range Date Types
get
Retrieve All Query Types
get
Activity Resource Queries
Retrieve All Resource Queries or by Name
get
Create Resource Query
post
Delete Resource Query by ID
delete
Retrieve Resource Query by ID
get
Update Resource Query by ID
put
Activity Resources
Create Resource
post
Delete Resource by ID
delete
Retrieve Resource by ID
get
Update Resource by ID
put
Activity Resources Data Retrieval
Retrieve All Activity Types
get
Retrieve All Activity Complete Statuses
get
Retrieve All Data Access Types
get
Retrieve All Eligible Default Activities
get
Retrieve All Event Types
get
Retrieve All Activity Held History
get
Retrieve All Hours Allocation Types
get
Retrieve All Activity Priority Types
get
Retrieve All Activity Process Types
get
Retrieve All Quantity Allocation Types
get
Retrieve All Sequence Validation Types
get
Activity Results Template Resources
Retrieve All Step Types
get
Activity Results Templates
Retrieve All Results Templates or by Name
get
Create Results Template
post
Create Results Templates
post
Delete Results Templates
post
Retrieve Results Templates
post
Update Results Templates
post
Delete Results Template by ID
delete
Retrieve Results Template by ID
get
Update Results Template by ID
put
Activity Settings
Retrieve All Activity Settings
get
Retrieve Activity Settings
post
Update Activity Settings
post
Retrieve Activity Setting by ID
get
Update Activity Setting by ID
put
Activity Shifts
Delete Activity Shifts
post
Retrieve Activity Shifts
post
Create or Update Activity Shifts
post
Activity Team Resources
Retrieve All Days of a Week
get
Activity Team Segment Audits
Retrieve Activity Team Segment Audits
post
Activity Team Segments
Delete Activity Team Segments
post
Retrieve Activity Team Segments
post
Create or Update Activity Team Segments
post
Activity Teams
Retrieve All Activity Teams or by Name
get
Create Activity Team
post
Delete Activity Teams
post
Retrieve Activity Teams
post
Create or Update Activity Teams
post
Delete Activity Team by ID
delete
Retrieve Activity Team by ID
get
Update Activity Team by ID
put
Activity Totals
Retrieve Activity Totals
get
Retrieve Activity Totals for Multiple Employees
post
Activity Transactions
Retrieve Activity Transactions
post
Field Definitions
Retrieve All Field Definitions or by Name
get
Create Field Definition
post
Create Field Definitions
post
Delete Field Definitions
post
Retrieve Field Definitions
post
Update Field Definitions
post
Delete Field Definition by ID
delete
Retrieve Field Definition by ID
get
Update Field Definition by ID
put
Result Code Profiles
Retrieve All Result Code Profiles by Name
get
Create Result Code Profile
post
Create Result Code Profiles
post
Delete Result Code Profiles
post
Retrieve Result Code Profiles
post
Update Result Code Profiles
post
Delete Result Code Profile by ID
delete
Retrieve Result Code Profile by ID
get
Update Result Code Profile by ID
put
Result Codes
Retrieve All Result Codes
get
Create Result Code
post
Create Result Codes
post
Delete Result Codes
post
Retrieve Result Codes
post
Update Result Codes
post
Create or Update Result Codes
post
Delete Result Code by ID
delete
Retrieve Result Code by ID
get
Update Result Code by ID
put
Team Segments Net Changes
Retrieve Net Changes for Team Segments
post
Team Transactions
Retrieve Team Transactions
post
Units of Measure
Retrieve All Units of Measure or by Name
get
Create Unit of Measure
post
Create Units of Measure
post
Delete Units of Measure
post
Retrieve Units of Measure
post
Update Units of Measure
post
Delete Unit of Measure by ID
delete
Retrieve Unit of Measure by ID
get
Update Unit of Measure by ID
put
Attendance
Actions
Complete Actions
post
Retrieve Actions' Documents
post
Retrieve Multiple Actions
post
Retrieve Action by ID
get
Update Action by ID
post
Retrieve Action Documents by ID
get
Attendance Audit Records
Retrieve Attendance Audit Records
post
Attendance Profiles
Retrieve All Attendance Profiles
get
Retrieve Attendance Profiles
post
Retrieve Attendance Profile by ID
get
Balance Adjustments
Update and Return Balances
post
Retrieve Balance Adjustments
post
Bulk Update and Return Balances
post
Mark Balance Adjustments for Deletion by ID
post
Balance Expirations
Retrieve Expiring Balances
post
Balance Resets
Reset Balances
post
Retrieve Balance Resets
post
Bulk Reset Balances
post
Mark Balance Resets for Deletion by ID
post
Balances
Retrieve Balances
post
Discipline Levels
Retrieve Discipline Levels
post
Events
Retrieve Events by Action
get
Create Events
post
Retrieve Events
post
Retrieve Event Types
get
Delete Event by ID
delete
Update Event by ID
post
Mark Event as Deleted by ID
post
Retrieve Event by ID
get
Markers
Create or Update Ignore Markers
post
Remove Ignore Markers
post
Retrieve Markers
post
Perfect Attendance
Retrieve Perfect Attendance Transactions
post
Perfect Attendance Deductions
Retrieve Perfect Attendance Deductions
post
Processor Requests
Retrieve Attendance Processor Requests
get
Create Attendance Processor Request
post
Delete Attendance Processor Request by ID
delete
Retrieve Attendance Processor Request by ID
get
Update Attendance Processor Request by ID
put
Profile Assignments
Retrieve Profile Assignments
post
Rules
Execute Attendance Rules for Employees
post
Common Resources I
Access Control Points
Retrieve All Access Control Points
get
Access Method Profiles
Retrieve All Access Method Profiles
get
Create Access Method Profile
post
Retrieve Access Methods
get
Delete Access Method Profiles
post
Retrieve Access Method Profiles
post
Create or Update Access Method Profiles
post
Retrieve Role Profiles for Access Method Profiles
get
Delete Access Method Profile by ID
delete
Retrieve Access Method Profile by ID
get
Update Access Method Profile by ID
put
Average Pay Rate Sets
Retrieve All Average Pay Rate Sets
get
Create Average Pay Rate Set
post
Retrieve Average Pay Rate Set - One Location
post
Create Average Pay Rate Sets
post
Delete Average Pay Rate Sets
post
Update Average Pay Rate Sets
post
Delete Average Pay Rate Set by ID
delete
Update Average Pay Rate Set by ID
put
Average Pay Rates
Retrieve Average Pay Rate - One Location
post
Biometric Consent History
Retrieve Biometric Consent History
post
Bulk Downloads
Retrieve Download Request Summary
get
Submit Bulk Download
post
Delete Bulk Downloads
post
Retrieve Bulk Download Results
get
Retrieve Download Status
get
Comments
Retrieve Comments as Manager
get
Retrieve Comments as Employee
get
Control Center Profiles
Retrieve All Control Center Profiles
get
Retrieve Control Center Profiles
post
Retrieve Control Center Profile by ID
get
Cost Centers
Retrieve All Cost Centers (Deprecated)
get
Retrieve Paginated List of Cost Centers
post
Create Cost Centers
post
Delete Cost Centers
post
Retrieve Cost Centers
post
Update Cost Centers
post
Retrieve Cost Center by ID (Deprecated)
get
Retrieve All Cost Centers
get
Retrieve Cost Center by ID
get
Custom Tiles
Retrieve All Custom Tiles
get
Create Custom Tile
post
Retrieve Custom Tiles
post
Delete Custom Tile by ID
delete
Retrieve Custom Tile by ID
get
Update Custom Tile by ID
put
Delegate Profiles
Retrieve All Delegate Profiles
get
Create Delegate Profile
post
Add or Remove Delegate Profile Delegates
post
Add or Remove Delegate Profile Delegates Asynchronously
post
Retrieve Summary of Asynchronous Delegate Profile Jobs
get
Retrieve Asynchronous Response Payload by Key
get
Retrieve Delegate Profile Asynchronous Request Status by Key
get
Delete Delegate Profiles
post
Retrieve Delegate Profiles
post
Create or Update Delegate Profiles
post
Create or Update Delegate Profiles Asynchronously
post
Delete Delegate Profile by ID
delete
Retrieve Delegate Profile by ID
get
Update Delegate Profile by ID
put
Device Groups
Retrieve Device Groups
get
Display Profiles
Retrieve All Display Profiles
get
Create Display Profile
post
Create Display Profiles
post
Delete Display Profiles
post
Retrieve Display Profiles
post
Update Display Profiles
post
Delete Display Profile by ID
delete
Retrieve Display Profile by ID
get
Update Display Profile by ID
put
Domain Event Categories
Retrieve All Domain Event Categories
get
Create Domain Event Category
post
Retrieve Domain Event Categories
post
Create or Update Domain Event Categories
post
Delete Domain Event Category by ID
delete
Retrieve Domain Event Category by ID
get
Update Domain Event Category by ID
put
Domain Event Navigations
Retrieve All Domain Event Navigations
get
Create Domain Event Navigation
post
Retrieve Domain Event Navigations
post
Update or Create Domain Event Navigations
post
Delete Domain Event Navigation by ID
delete
Retrieve Domain Event Navigation by ID
get
Update Domain Event Navigation by ID
put
Domain Events
Retrieve All Domain Events
get
Create Domain Event
post
Delete Domain Events
post
Retrieve Domain Events
post
Create or Update Domain Events
post
Delete Domain Event by ID
delete
Retrieve Domain Event by ID
get
Update Domain Event by ID
put
Dynamic Event Notification Mappings
Retrieve All Dynamic Event Notification Mappings
get
Create a Dynamic Event Notification Mapping
post
Delete Dynamic Event Notification Mappings
post
Retrieve Dynamic Event Notification Mappings
post
Create or Update Dynamic Event Notification Mappings
post
Delete Dynamic Event Notification Mapping by ID
delete
Retrieve Dynamic Event Notification Mapping by ID
get
Update a Dynamic Event Notification Mapping by ID
put
Dynamic Event Notifications
Send Dynamic Event Notifications
post
Employee Groups
Retrieve All Employee Groups or by Name
get
Create Employee Groups
post
Retrieve Employee Groups
post
Update Employee Groups
post
Retrieve Employee Group by ID
get
Employee Photos
Retrieve Photos for Multiple Employees
post
Entitlements
Entitlement History
get
Entitlement Summary
get
Feature Switches
Retrieve Feature Switches
post
Retrieve Feature Switch by Name
get
Fiscal Calendars
Create Fiscal Periods
post
Delete Fiscal Periods
post
Function Access Profiles
Retrieve All Function Access Profiles or by Name
get
Create Function Access Profile
post
Delete Function Access Profile by ID
delete
Retrieve Function Access Profile by ID
get
Update Function Access Profile by ID
put
Generic Data Access Profiles
Create or Update Generic Data Access Profiles
post
Retrieve Generic Data Access Profile by ID With Available Items
get
Retrieve Generic Data Access Profiles
post
Retrieve Setup Category Available Items for Generic Data Access Profile
get
Retrieve Generic Data Access Profile by ID
get
Retrieve All Generic Data Access Profiles by Category ID
get
Retrieve All Generic Data Access Profiles Categories
get
Generic Notifications
Retrieve All Generic Notifications
get
Create Generic Notification
post
Delete Generic Notifications
post
Retrieve Generic Notifications
post
Create or Update Generic Notifications
post
Delete Generic Notification
delete
Retrieve Generic Notification by ID
get
Update Generic Notification
put
Hours of Operation
Retrieve All Hours of Operation or by Name (Deprecated)
get
Create Hours of Operation (Deprecated)
post
Create Multiple Hours of Operation (Deprecated)
post
Delete Multiple Hours of Operation (Deprecated)
post
Retrieve Multiple Hours of Operation (Deprecated)
post
Update Multiple Hours of Operation (Deprecated)
post
Delete Hours of Operation by ID (Deprecated)
delete
Retrieve Hours of Operation by ID (Deprecated)
get
Update Hours of Operation by ID (Deprecated)
put
Retrieve All Hours of Operation or by Name
get
Create Hours of Operation
post
Create Multiple Hours of Operation
post
Delete Multiple Hours of Operation
post
Retrieve Multiple Hours of Operation
post
Update Multiple Hours of Operation
post
Delete Hours of Operation Effective Version
post
Delete Hours of Operation by ID
delete
Retrieve Hours of Operation by ID
get
Update Hours of Operation by ID
put
Hours of Operation Assignments
Retrieve Hours of Operation Assignments for One Location
get
Delete Hours of Operation Assignments
post
Retrieve Hours of Operation Assignments for Multiple Locations
post
Create or Update Hours of Operation Assignments
post
Hours of Operation Override Assignments
Retrieve Hours of Operation Override Assignment
get
Delete Hours of Operation Override Assignments
post
Retrieve Hours of Operation Override Assignments
post
Create or Update Hours of Operation Override Assignments
post
Hours of Operation Overrides
Retrieve All Hours of Operation Overrides or by Name
get
Create Hours of Operation Override
post
Create Hours of Operation Overrides
post
Delete Hours of Operation Overrides
post
Retrieve Hours of Operation Overrides
post
Update Hours of Operation Overrides
post
Delete Hours of Operation Override by ID
delete
Retrieve Hours of Operation Override by ID
get
Update Hours of Operation Override by ID
put
Known IP Addresses
Retrieve Known IP Addresses
get
Create Known IP Address
post
Create or Update Known IP Addresses
post
Delete Known IP Address by ID
delete
Retrieve Known IP Address by ID
get
Update Known IP Address by ID
put
Messaging Notifications
Retrieve Notifications
get
Retrieve Bulk Notifications
post
Retrieve Control Center Configuration
get
Retrieve Notification Count
get
Retrieve Notifications by Item ID
get
Delete Multiple Notifications
post
Retrieve Notifications by Item IDs
post
Review Notifications by ID
post
Retrieve Notification Details
get
Notification Profiles
Retrieve All Notification Profiles
get
Retrieve Notification Profiles
post
Retrieve Notification Profile by ID
get
Retrieve Available Notification Profile by ID
get
Pay Period Timespans
Retrieve Pay Period Timespans
get
Payroll Export
Export Small Batch Payroll
post
Retrieve Summary of Asynchronous Payroll Export Jobs
get
Export Payroll Asynchronously
post
Retrieve Payroll Export Asynchronous Response Payload by Key
get
Retrieve Payroll Export Asynchronous Request Status by Key
get
Payroll Staging
Stage Payroll Asynchronously
post
Retrieve Asynchronous Payroll Staging Details by ID
get
Retrieve Payroll Staging Asynchronous Request Status by ID
get
Payroll Tables
Retrieve All Payroll Tables
get
Create Payroll Table
post
Create or Update Payroll Table
post
Delete Payroll Table by Name
delete
Retrieve Payroll Table by Name
get
Proactively Guide Employees - Behaviors Configuration
Retrieve All PGE Behaviors Configurations
get
Retrieve PGE Behaviors Configuration by ID
get
Update PGE Behaviors Configuration by ID
put
Proactively Guide Employees - Behaviors Configuration Items
Retrieve PGE Behaviors Configuration Items
get
Create PGE Behaviors Configuration Item
post
Delete PGE Behaviors Configuration Item by ID
delete
Retrieve PGE Behaviors Configuration Item by ID
get
Update PGE Behaviors Configuration Item by ID
put
Process Profiles
Retrieve Available Process Profile by ID
get
Retrieve Process Profile by ID
get
Retrieve All Process Profiles
get
Retrieve Process Profiles
post
Reviewer Lists
Retrieve Reviewer List by Criteria
get
Create Reviewer List
post
Create Reviewer Lists
post
Delete Reviewer Lists
post
Update Reviewer Lists
post
Retrieve Reviewers for Reviewer Lists
get
Delete Reviewer List by ID
delete
Retrieve Reviewer List by ID
get
Update Reviewer List by ID
put
Reviewer Purposes
Retrieve All Reviewer Purposes or by Name (Deprecated)
get
Create Reviewer Purpose
post
Delete Reviewer Purpose by ID
delete
Retrieve Reviewer Purpose by ID
get
Update Reviewer Purpose by ID
put
Role Profiles
Retrieve All Role Profiles or by Name
get
Create Role Profile
post
Delete Role Profiles
post
Create or Update Role Profiles
post
Delete Role Profile by ID
delete
Retrieve Role Profile by ID
get
Update Role Profile by ID
put
Symbolic Periods
Retrieve Symbolic Periods
get
Retrieve Date Span Grouped by Symbol Type
post
Retrieve Symbolic Period Types
get
Retrieve Locale Date Span
post
Retrieve Symbolic Periods Grouped by Type
post
Retrieve Symbolic Periods by Period Type ID
get
Symbolic Purposes
Retrieve All Symbolic Purposes or by Name or Type
get
Create Symbolic Purpose
post
Delete Symbolic Purpose by ID
delete
Retrieve Symbolic Purpose by ID
get
Update Symbolic Purpose by ID
put
Symbolic Reviewers and Listeners
Retrieve Symbolic Reviewers and Listeners
post
TeleTime IP User Profiles
Retrieve TeleTime IP User Profiles
get
Timecard Approval Methods
Retrieve Timecard Approval Methods
get
Timezones
Retrieve Timezone
get
Retrieve Timezone by ID
get
Set Timezone
put
Transaction Assistant
Retrieve All Transaction Assistant Records
post
Transfer Display Profiles
Retrieve All Transfer Display Profiles
get
Create Transfer Display Profile
post
Delete Transfer Display Profile by ID
delete
Retrieve Transfer Display Profile by ID
get
Update Transfer Display Profile by ID
put
WiFi Access Points
Retrieve All WiFi Access Points
get
Create WiFi Access Point
post
Delete WiFi Access Points
post
Create or Update WiFi Access Points
post
Delete WiFi Access Point by ID
delete
Retrieve WiFi Access Point by ID
get
Update WiFi Access Point by ID
put
WiFi Networks
Retrieve All WiFi Networks
get
Create WiFi Network
post
Delete WiFi Networks
post
Create or Update WiFi Networks
post
Delete WiFi Network by ID
delete
Retrieve WiFi Network by ID
get
Update WiFi Network by ID
put
Common Resources II
Aggregated Data
Retrieve Data
post
Currency Definitions
Retrieve All Currency Definitions
get
Retrieve Currency Definition by ID
get
Currency Policies
Retrieve All Currency Policies
get
Create Currency Policy
post
Update Currency Policy
post
Retrieve Base Currency Policy
get
Retrieve Currency Policies
post
Create or update Currency Policies
post
Retrieve Currency Policy by ID
get
Data Dictionary
Retrieve Data Element Definitions
get
Retrieve Data Element Definitions by Keys
post
Dataview Profiles
Retrieve All Dataview Profiles
get
Create Dataview Profile
post
Retrieve Dataview Profiles
post
Delete Dataview Profile by ID
delete
Retrieve Dataview Profile by ID
get
Update Dataview Profile by ID
put
Dataviews
Retrieve Dataviews
get
Create Administrator Dataview
post
Retrieve Dataview by Criteria
post
Delete Administrator Dataview by ID
delete
Retrieve Dataview by ID
get
Update Administrator Dataview by ID
put
Delete Personalized Dataview by ID
delete
Create Personalized Dataview
post
Update Personalized Dataview by ID
put
Exchange Rates
Retrieve Converted Amount
post
GPS Known Places
Delete Known Place by Persistent ID
delete
Retrieve All Known Places or by Specification
get
Create Known Place
post
Update Known Place by Persistent ID
put
Create Known Places
post
Delete Known Places
post
Retrieve Known Places
post
Create or Update Known Places
post
Delete Known Place by ID
delete
Retrieve Known Place by ID
get
Update Known Place by ID
put
Generic Locations
Retrieve a List of Generic Locations
get
Create Generic Location
post
Retrieve Generic Locations
post
Create or Update Generic Locations
post
Delete Generic Location by ID
delete
Retrieve Generic Location by ID
get
Update Generic Location by ID
put
Home Pages
Retrieve Home Pages
get
Create Home Page
post
Retrieve Home Page Profiles
post
Delete Home Page by ID
delete
Retrieve Home Page by ID
get
Update Home Page by ID
put
Delete a Personalized Home Page by ID
delete
Personalize Home Page by ID
post
Hyperfind Profiles
Retrieve All Hyperfind Profiles
get
Retrieve Hyperfind Profiles
post
Retrieve Hyperfind Profile by ID
get
Hyperfind Queries
Retrieve Hyperfind Queries for Current User
get
Retrieve Hyperfind Filter Details by Filter ID
get
Execute Hyperfind Query
post
Retrieve Hyperfind Filters
get
Delete Hyperfind Queries
post
Retrieve Hyperfind Queries
post
Create or Update Hyperfind Queries
post
Retrieve Personal Hyperfind Queries for Inactive and Terminated Employees
get
Delete Personal Hyperfind Queries
post
Retrieve Public Hyperfind Queries
get
Retrieve Hyperfind Query by ID
get
Jobs
Delete Generic Job
delete
Retrieve Effective Job by Name
get
Create Generic Job
post
Retrieve Generic Jobs by Job Assignment
post
Retrieve Effective Job References by External IDs
post
Retrieve Effective Job Reference by External ID
get
Retrieve Generic Jobs by Reference
post
Retrieve Job Mappings by Persistent IDs
post
Delete Generic Job by ID
delete
Retrieve Effective Job by ID
get
Update Generic Job by ID
post
Delete Multiple Generic Jobs
post
Labor Categories
Retrieve All Labor Categories or by Name (Deprecated)
get
Create Labor Categories
post
Delete Labor Categories
post
Update Labor Categories
post
Retrieve Labor Category by ID (Deprecated)
get
Retrieve All Labor Categories or by Criteria
get
Retrieve Labor Category by ID
get
Labor Category Entries
Retrieve Labor Category Entries by Category ID (Deprecated)
get
Retrieve Paginated List of Labor Category Entries
post
Create Labor Category Entries
post
Delete Labor Category Entries
post
Retrieve Labor Category Entries
post
Update Labor Category Entries
post
Delete Labor Category Entry by ID
delete
Retrieve Labor Category Entry by ID (Deprecated)
get
Retrieve Labor Category Entries by Category ID
get
Retrieve Labor Category Entry by ID
get
Labor Category List Assignments
Create Labor Category List Assignments
post
Delete Labor Category List Assignments
post
Delete Labor Category List Assignments by ID (Deprecated)
post
Retrieve Labor Category List Assignments
post
Update Labor Category List Assignments
post
Labor Category Lists
Retrieve All Labor Category Lists
get
Retrieve Labor Category List of Entries
post
Create Labor Category Lists
post
Delete Labor Category Lists
post
Update Labor Category Lists
post
Create or Update Labor Category Lists
post
Delete Labor Category List by ID
delete
Retrieve Labor Category List by ID
get
Retrieve All Labor Category Lists with Effective Versions
get
Retrieve Paginated Labor Category List with Effective Version
post
Create Labor Category Lists with Effective Versions
post
Update Labor Category Lists with Effective Versions
post
Retrieve Labor Category List with Effective Version by ID
get
Labor Category Profiles
Delete Labor Category Profile by ObjectRef
delete
Retrieve All Labor Category Profiles
get
Retrieve Paginated List of Labor Category Profiles
post
Retrieve Labor Category Profile for Current User
get
Create Labor Category Profiles
post
Delete Labor Category Profiles
post
Retrieve Labor Category Profiles
post
Update Labor Category Profiles
post
Create or Update Labor Category Profiles
post
Delete Labor Category Profile by ID
delete
Retrieve Labor Category Profile by ID
get
Labor Entry Lists
Retrieve Labor Entry Lists
post
Locale Policies
Retrieve Locale Policy
get
Create Locale Policy
post
Set Default Locale Policy
post
Create Locale Policies
post
Delete Locale Policies
post
Retrieve Locales
post
Update Locale Policies
post
Delete Locale Policy by ID
delete
Retrieve Locale Policy by ID
get
Update Locale Policy by ID
post
Location Attribute Assignments
Retrieve Location Attribute Value
post
Location Attribute Start Day Of Week
Retrieve a Location Attribute Week Span
post
Location Attributes
Retrieve Location Attribute by Criteria
get
Create Location Attribute
post
Delete Location Attributes
post
Retrieve Location Attributes
post
Create or Update Location Attributes
post
Delete Location Attribute by ID
delete
Retrieve Location Attribute by ID
get
Update Location Attribute by ID
put
Location Sets
Retrieve Location Set by Name
get
Create Location Set
post
Create or Update Location Set
post
Delete Location Sets
post
Retrieve Location Sets by List (Deprecated)
post
Update Location Set by ID
post
Retrieve Location Set by ID
get
Retrieve Paginated List of Location Sets
post
Location Types
Delete Location Type
delete
Retrieve Location Types by Name
get
Create Location Type
post
Retrieve Location Types by Location
post
Retrieve Location Types by External IDs
post
Retrieve Location Type by External ID
get
Retrieve Location Types by Context
post
Retrieve Location Types by Persistent IDs
post
Delete Location Type by ID
delete
Retrieve Location Type by ID
get
Update Location Type by ID
post
Locations
Retrieve Location by Path
get
Create Location Node
post
Copy Location
post
Move Location
post
Move Locations Asynchronously
post
Retrieve Locations by External IDs
post
Retrieve Location by External ID
get
Create Locations
post
Create Locations Asynchronously
post
Delete Locations
post
Retrieve Locations
post
Update Locations
post
Update Locations Asynchronously
post
Retrieve Location Mappings by Persistent IDs
post
Retrieve Asynchronous Locations Request Status by ID
get
Retrieve Location by ID
get
Update Location by ID
post
Retrieve Paginated List of Locations
post
Tiles
Retrieve Tiles
get
Create Admin Tile
post
Delete Admin Tile by ID
delete
Retrieve Tile by ID
get
Update Admin Tile by ID
put
Time Increment Resolver
Resolve Time Increments
post
User Preferences
Retrieve User Preferences
get
Retrieve User Preferences for Current User
get
Employee Self-Service
Employee Availability Pattern Requests
Create Availability Pattern Request
post
Update Availability Pattern Request State
post
Retrieve Availability Types for Availability Pattern Request Segments
get
Retrieve Request Subtypes by Availability Type for Pattern Requests
get
Retrieve Submission Periods for Pattern Requests
get
Retrieve Availability Pattern Request by ID
get
Employee Availability Requests
Create Availability Request
post
Update Availability Request State
post
Retrieve Availability Types for Availability Segments
get
Retrieve Availability Requests
post
Retrieve Request Subtypes by Availability Type
get
Retrieve Submission Periods by Availability Type or Subtype
get
Retrieve Availability Request by ID
get
Employee Cover Requests
Create Shift Cover Request
post
Update Shift Cover Request
post
Retrieve Candidate Employees
get
Invalidate Cover Request
post
Retrieve Shift Cover Requests
post
Retrieve Shift Cover Request Subtypes
get
Retrieve Offerable Shifts
get
Retrieve Submission Periods
get
Retrieve Shift Cover Request by ID
get
Employee Open Shift Requests
Create Employee Open Shift Request
post
Retrieve Open Shift Request Information (Deprecated)
post
Update Employee Open Shift Request
post
Retrieve Other Employees Reporting to Manager
get
Retrieve Jobs for Open Shift Requests
get
Retrieve Employee Open Shift Requests
post
Retrieve Requestable Open Shifts
post
Retrieve Open Shift Request Subtypes
get
Retrieve Employee Open Shift Resources (Deprecated)
post
Retrieve Request Submission Periods
get
Retrieve Employee Open Shift Request by ID
get
Employee Schedules
Retrieve Employee Schedule
get
Employee Self-Schedule Requests
Create Self-Schedule Request
post
Update Self-Schedule Request by ID
put
Retrieve Requestable Open Shifts, Request Subtypes, or Submission Periods (Deprecated)
post
Update Self-Schedule Request State
post
Retrieve Other Employees Reporting to Manager for Self-Scheduling
get
Retrieve Self-Schedule Request by Job ID
get
Retrieve Self-Schedule Requests
post
Retrieve Requestable Open Shifts (Deprecated)
post
Retrieve Requestable Open Shifts for Self-Scheduling
post
Retrieve Open Self-Scheduling Request Subtypes
get
Retrieve Requestable Shift Templates for Self-Scheduling
post
Retrieve Self-Scheduling Request Submission Periods
get
Retrieve Self-Schedule Request by ID
get
Employee Swap Requests
Create Shift Swap Request
post
Retrieve Shift Swap Request Information
post
Update Shift Swap Request
post
Retrieve Shift Swap Requests
post
Retrieve Shift Swap Request by ID
get
Employee Time Off Requests
Create Employee Time Off Request
post
Retrieve Employee Accrual Balance
get
Update Employee Time Off Request
post
Retrieve Employee Time Off Requests
post
Retrieve Employee Request Period
get
Retrieve Employee Request Subtype
get
Retrieve Employee Symbolic Value
get
Retrieve Employee Time Off Request by ID
get
Fill Open Shifts
Accept Open Shift
post
Decline Open Shift
post
Send Open Shift Notifications
post
Manager Availability Pattern Requests
Update Availability Pattern Request State as Manager
post
Retrieve Availability Pattern Requests as Manager
post
Manager Availability Requests
Update Availability Request State as Manager
post
Retrieve Availability Requests as Manager
post
Manager Cover Requests
Update Shift Cover Request as Manager
post
Retrieve Shift Cover Requests as Manager
post
Retrieve Shift Cover Request by ID as Manager
get
Retrieve Rule Violations for Shift Cover Request
get
Manager Open Shift Requests
Update Open Shift Request
post
Retrieve Open Shift Requests as Manager
post
Retrieve Similar Open Shift Requests by ID
get
Retrieve Open Shift Request by ID
get
Manager Self-Schedule Requests
Retrieve Self-Schedule Requests as Manager
post
Manager Swap Requests
Retrieve Rule Violations for Shift Swap Request
post
Update Shift Swap Request as Manager
post
Retrieve Shift Swap Requests as Manager
post
Retrieve Shift Swap Request by ID as Manager
get
Manager Time Off Requests
Create Time Off Request as Manager
post
Retrieve Accrual Balance as Manager
get
Update Time Off Request as Manager
post
Retrieve Time Off Requests as Manager
post
Retrieve Request Period as Manager
get
Retrieve Request Subtype as Manager
get
Retrieve Symbolic Value as Manager
get
Retrieve Time Off Request by ID as Manager
get
Create Time Off Request as Manager for Overridden Shifts
post
Update Time Off Request by ID as Manager
put
Time Off Request Guided Recommendations
Retrieve Guided Recommendations
post
Forecasting Setup
Adjustment Driver Settings
Retrieve All Adjustment Driver Settings or by Name
get
Create Adjustment Driver Settings
post
Retrieve Adjustment Driver Settings by Location
post
Create Multiple Adjustment Driver Settings
post
Delete Multiple Adjustment Driver Settings
post
Retrieve Adjustment Driver Settings
post
Update Multiple Adjustment Driver Settings
post
Delete Adjustment Driver Settings by ID
delete
Retrieve Adjustment Driver Settings by ID
get
Update Adjustment Driver Settings by ID
put
Budget Distribution Types
Retrieve All Budget Distribution Types
get
Category Property Set Assignments
Retrieve Category Property Set Assignments by Category
get
Delete Category Property Set Assignments
post
Retrieve Category Property Set Assignments
post
Create or Update Category Property Set Assignments
post
Category Property Sets
Retrieve All Category Property Sets, Only Active, or by Name
get
Create Category Property Set
post
Create Category Property Sets
post
Retrieve Category Property Sets
post
Retrieve Category Property Set by ID
get
Combined Labor Distributions
Retrieve All Combined Labor Distributions or by Specification
get
Create Combined Labor Distribution
post
Create Combined Labor Distributions
post
Delete Combined Labor Distributions
post
Retrieve Combined Labor Distributions
post
Update Combined Labor Distributions
post
Delete Combined Labor Distribution by ID
delete
Retrieve Combined Labor Distribution by ID
get
Update Combined Labor Distribution by ID
put
Custom Driver Assignments
Retrieve Custom Driver Assignments
get
Retrieve Custom Driver Assignments by Context
post
Retrieve Custom Driver Assignments by Category
post
Custom Drivers
Update Custom Driver Values
post
Retrieve Custom Driver Values
post
Update Values for Multiple Custom Drivers
post
Forecast Planner Profiles
Delete a Forecast Planner Profile by Name
delete
Retrieve All Forecast Planner Profiles or by Name
get
Create a Forecast Planner Profile
post
Create Forecast Planner Profiles
post
Delete Forecast Planner Profiles
post
Retrieve Forecast Planner Profiles
post
Update Forecast Planner Profiles
post
Delete a Forecast Planner Profile by ID
delete
Retrieve a Forecast Planner Profile by ID
get
Update a Forecast Planner Profile by ID
put
Forecast Planner Settings
Delete a Forecast Planner Setting by Name
delete
Retrieve All Forecast Planner Settings or by Name
get
Create a Forecast Planner Setting
post
Create Forecast Planner Settings
post
Delete Forecast Planner Settings
post
Retrieve Forecast Planner Settings
post
Update Forecast Planner Settings
post
Retrieve Factor Definition Types
get
Retrieve Steps
get
Retrieve Volume Drivers Available to Forecast Planner
get
Retrieve Volume Forecast Intervals
get
Delete a Forecast Planner Setting by ID
delete
Retrieve a Forecast Planner Setting by ID
get
Update a Forecast Planner Setting by ID
put
Forecast Week
Retrieve a Forecast Week (Deprecated)
get
Retrieve a Forecast Week
get
Forecast Week Start Days
Retrieve Forecast Week Default Start Day (Deprecated)
get
Retrieve Forecast Week Start Day by ID (Deprecated)
get
Retrieve Forecast Week Start Days (Deprecated)
post
Retrieve Forecast Week Default Start Day
get
Retrieve Forecast Week Start Day by ID
get
Retrieve Forecast Week Start Days
post
Generic Categories
Retrieve All Generic Categories or by Name (Deprecated)
get
Retrieve Generic Categories (Deprecated)
post
Retrieve Generic Category by ID (Deprecated)
get
Retrieve All Generic Categories or by Name
get
Retrieve Generic Categories
post
Retrieve Generic Category by ID
get
Generic Departments
Retrieve All Generic Departments or by Name
get
Retrieve Generic Department by ID
get
Hours of Operation Assignments (Deprecated)
Retrieve Hours of Operation Assignments--One Location (Deprecated)
get
Delete Hours of Operation Assignments (Deprecated)
post
Retrieve Hours of Operation Assignments for Multiple Locations (Deprecated)
post
Create or Update Hours of Operation Assignments (Deprecated)
post
Hours of Operation Override Assignments (Deprecated)
Retrieve Hours of Operation Override Assignment (Deprecated)
get
Delete Hours of Operation Override Assignments (Deprecated)
post
Retrieve Hours of Operation Override Assignments (Deprecated)
post
Create or Update Hours of Operation Override Assignments (Deprecated)
post
Hours of Operation Overrides (Deprecated)
Retrieve All Hours of Operation Overrides or by Name (Deprecated)
get
Create Hours of Operation Override (Deprecated)
post
Create Hours of Operation Overrides (Deprecated)
post
Delete Hours of Operation Overrides (Deprecated)
post
Retrieve Hours of Operation Overrides (Deprecated)
post
Update Hours of Operation Overrides (Deprecated)
post
Delete Hours of Operation Override by ID (Deprecated)
delete
Retrieve Hours of Operation Override by ID (Deprecated)
get
Update Hours of Operation Override by ID (Deprecated)
put
Labor Constraint Profiles
Retrieve All Labor Constraint Profiles or by Name
get
Create a Labor Constraint Profile
post
Retrieve a Labor Constraint Profile by Location
post
Create Labor Constraint Profiles
post
Delete Labor Constraint Profiles
post
Retrieve Labor Constraint Profiles
post
Update Labor Constraint Profiles
post
Delete a Labor Constraint Profile by ID
delete
Retrieve a Labor Constraint Profile by ID
get
Update a Labor Constraint Profile by ID
put
Labor Constraint Settings
Retrieve All Labor Constraint Settings or by Name
get
Create Labor Constraint Settings
post
Create Multiple Labor Constraint Settings
post
Delete Labor Constraint Settings
post
Retrieve Labor Constraint Settings
post
Update Multiple Labor Constraint Settings
post
Retrieve Adjustment Types
get
Retrieve Control Types
get
Retrieve Labor Forecast Distribution Method Types
get
Retrieve Period Distributions
get
Delete Labor Constraint Settings by ID
delete
Retrieve Labor Constraint Settings by ID
get
Update Labor Constraint Settings by ID
put
Labor Distribution Group Profiles
Retrieve All Labor Distribution Group Profiles or by Name
get
Create Labor Distribution Group Profile
post
Retrieve Labor Distribution Group Profile by Location
post
Create Labor Distribution Group Profiles
post
Delete Labor Distribution Group Profiles
post
Retrieve Labor Distribution Group Profiles
post
Update Labor Distribution Group Profiles
post
Delete Labor Distribution Group Profile by ID
delete
Retrieve Labor Distribution Group Profile by ID
get
Update Labor Distribution Group Profile by ID
put
Labor Distribution Groups
Retrieve All Labor Distribution Groups or by Name
get
Create Labor Distribution Group
post
Create Labor Distribution Groups
post
Delete Labor Distribution Groups
post
Retrieve Labor Distribution Groups
post
Update Labor Distribution Groups
post
Retrieve All Allocation Method Types
get
Retrieve All Borrow Hours Types
get
Delete Labor Distribution Group by ID
delete
Retrieve Labor Distribution Group by ID
get
Update Labor Distribution Group by ID
put
Labor Forecast
Update Labor Forecast
post
Retrieve Labor Forecasts
post
Import Labor Forecasts (Deprecated)
post
Create Labor Forecasts
post
Retrieve Labor Forecasts for Multiple Locations
post
Update Labor Forecasts
post
Labor Forecast Limits
Retrieve Labor Forecast Limit by Name (Deprecated)
get
Create Labor Forecast Limit (Deprecated)
post
Create Labor Forecast Limits (Deprecated)
post
Delete Labor Forecast Limits (Deprecated)
post
Retrieve Labor Forecast Limits (Deprecated)
post
Update Labor Forecast Limits (Deprecated)
post
Delete Labor Forecast Limit by ID (Deprecated)
delete
Retrieve Labor Forecast Limit by ID (Deprecated)
get
Update Labor Forecast Limit by ID (Deprecated)
put
Retrieve Labor Forecast Limit by Name
get
Create Labor Forecast Limit
post
Retrieve Labor Forecast Limits by Criteria
post
Create Labor Forecast Limits
post
Delete Labor Forecast Limits
post
Update Labor Forecast Limits
post
Delete Labor Forecast Limit Effective Version
post
Delete Labor Forecast Limit by ID
delete
Retrieve Labor Forecast Limit by ID
get
Update Labor Forecast Limit by ID
put
Labor Standards
Retrieve All Labor Standards or by Specification (Deprecated)
get
Create Labor Standard
post
Update Labor Standard
post
Retrieve Labor Driver Adjustment Operations
get
Create Labor Standards
post
Delete Labor Standards
post
Retrieve Labor Standards
post
Update Labor Standards
post
Delete Labor Standard by ID
delete
Retrieve Labor Standard by ID
get
Labor Standards, Tasks, and Task Groups
Import Labor Standards, Tasks, and Task Groups (Deprecated)
post
Purge Labor Standards (Deprecated)
post
Import Labor Standards, Tasks, and Task Groups
post
Purge Labor Standards
post
Labor Tasks
Retrieve All Labor Tasks or by Specification (Deprecated)
get
Create Labor Task (Deprecated)
post
Create Labor Tasks (Deprecated)
post
Delete Labor Tasks (Deprecated)
post
Retrieve Labor Tasks (Deprecated)
post
Update Labor Tasks (Deprecated)
post
Delete Labor Task by ID (Deprecated)
delete
Retrieve Labor Task by ID (Deprecated)
get
Update Labor Task by ID (Deprecated)
put
Retrieve Labor Tasks by Name and Department
get
Create Labor Task
post
Create Labor Tasks
post
Delete Labor Tasks
post
Retrieve Labor Tasks
post
Update Labor Tasks
post
Delete Labor Task Effective Version by Criteria
post
Delete Labor Task by ID
delete
Retrieve Labor Task by ID
get
Update Labor Task by ID
put
Linked Categories
Retrieve All Linked Categories or by Specification
get
Create Linked Categories
post
Delete Linked Categories
post
Retrieve Linked Categories
post
Update Linked Categories
post
Linked Category Action Types
Retrieve Linked Category Action Types
get
Machine Learning Models
Delete Machine Learning Model by Name
delete
Retrieve All Machine Learning Models or by Name
get
Create Machine Learning Model
post
Create Machine Learning Models
post
Delete Machine Learning Models
post
Retrieve Machine Learning Models
post
Update Machine Learning Models
post
Delete Machine Learning Model by ID
delete
Retrieve Machine Learning Model by ID
get
Update Machine Learning Model by ID
put
Period of Application Types
Retrieve Period of Application Types
get
Special Event Assignments
Retrieve Special Event Assignments by Category
get
Create Special Event Assignments
post
Delete Special Event Assignments
post
Retrieve Special Event Assignments
post
Special Events
Retrieve All Special Events
get
Create a Special Event
post
Create Special Events
post
Delete Special Events
post
Retrieve Special Events
post
Update Special Events
post
Delete Special Event by ID
delete
Retrieve a Special Event by ID
get
Update Special Event by ID
put
Static Driver Assignments
Retrieve Static Driver Assignments by Category
get
Create Static Driver Assignments
post
Delete Static Driver Assignments
post
Retrieve Static Driver Assignments
post
Update Static Driver Assignments
post
Static Drivers
Retrieve All Static Drivers or by Name (Deprecated)
get
Retrieve Static Driver by ID (Deprecated)
get
Retrieve All Static Drivers or by Name
get
Retrieve Static Driver by ID
get
Task Groups
Retrieve Task Groups by Name or Generic Department (Deprecated)
get
Create Task Group (Deprecated)
post
Create Task Groups (Deprecated)
post
Delete Task Groups (Deprecated)
post
Retrieve Task Groups (Deprecated)
post
Update Task Groups (Deprecated)
post
Delete Task Group by ID (Deprecated)
delete
Retrieve a Task Group by ID (Deprecated)
get
Update Task Group by ID (Deprecated)
put
Retrieve All Task Groups or by Name or Generic Department
get
Create Task Group
post
Retrieve Task Groups by Criteria
post
Create Task Groups
post
Delete Task Groups
post
Retrieve Task Groups
post
Update Task Groups
post
Delete Task Group Effective Version by Criteria
post
Delete Task Group by ID
delete
Retrieve a Task Group by ID
get
Update Task Group by ID
put
Volume Driver Assignments
Retrieve a Volume Driver Assignment
get
Retrieve Volume Driver Assignments
post
Create or Update Volume Driver Assignments
post
Volume Drivers
Retrieve All Volume Drivers or by Name
get
Create Volume Driver
post
Create Volume Drivers
post
Delete Volume Drivers
post
Retrieve Volume Drivers
post
Update Volume Drivers
post
Delete Volume Driver by ID
delete
Retrieve Volume Driver by ID
get
Update Volume Driver by ID
put
Volume Forecast Model Types
Retrieve All Volume Forecast Model Types (Deprecated)
get
Retrieve All Volume Forecast Model Types
get
Forecasting
Accuracy Metrics Engine
Execute Accuracy Metrics Engine
post
Actual Volume
Retrieve Actual Volume by Sites
post
Import Actual Volume
post
Retrieve Actual Volume by Site
post
Adjustment Drivers
Update Adjustment Driver Values
post
Retrieve Adjustment Driver Values
post
Update Values for Multiple Adjustment Drivers
post
Basic Accuracy Engine
Execute Basic Accuracy Metrics Engine
post
Delete Basic Accuracy Metrics
post
Combined Distribution Offset Types
Retrieve Combined Distribution Offset Types
get
Combined Distribution Types
Retrieve Combined Distribution Types
get
Consolidated Labor Forecast
Retrieve Consolidated Labor Forecasts
post
Custom Drivers Setup
Retrieve a Custom Driver by Name and Generic Department
get
Create Custom Driver
post
Create Custom Drivers
post
Delete Custom Drivers
post
Retrieve Custom Drivers
post
Update Custom Drivers
post
Delete Custom Driver by ID
delete
Retrieve a Custom Driver by ID
get
Update Custom Driver by ID
put
Daily Actual Volume
Create Daily Actual Volume
post
Earned Hours Engine
Execute Earned Hours Engine
post
Engine Status
Retrieve Engine Statuses
post
Forecasted Jobs
Retrieve Forecasted Jobs
post
Forecasting Audits
Retrieve Forecasting Audit Data
post
Forecasting Category Profiles
Retrieve All Forecasting Category Profiles, Only Active, or by Name
get
Create Forecasting Category Profile
post
Create Forecasting Category Profiles
post
Delete Forecasting Category Profiles
post
Retrieve Forecasting Category Profiles
post
Update Forecasting Category Profiles
post
Delete Forecasting Category Profile by ID
delete
Retrieve Forecasting Category Profile by ID
get
Update Forecasting Category Profile by ID
put
Labor Budget
Retrieve Labor Budgets
post
Update Labor Budgets
post
Import Labor Budgets
post
Retrieve Labor Budget Values
post
Labor Constraint Engine
Execute Labor Constraint Engine
post
Labor Forecast Analyzer
Execute Labor Forecast Analyzer
post
Labor Forecast Engine
Execute Labor Forecast Engine
post
Labor Forecast Limit Assignments
Delete Labor Forecast Limit Assignments
post
Retrieve Labor Forecast Limit Assignments
post
Create or Update Labor Forecast Limit Assignments
post
Labor Period Overrides
Delete Labor Period Overrides
post
Retrieve Labor Period Overrides
post
Create or Update Labor Period Overrides
post
Retrieve Overridable Tasks by Department
post
Machine Learning Model Features
Retrieve All Machine Learning Model Features or by Name
get
Retrieve Machine Learning Model Feature by ID
get
Peak Hours
Retrieve Peak Hours
post
SHAP Value Metrics
Calculate Feature Dependence
post
Calculate Feature Importance
post
Extract Local Explainer
post
Traffic Pattern Engine
Execute Traffic Pattern Engine
post
Traffic Patterns
Create Traffic Patterns
post
Delete Traffic Patterns
post
Retrieve Traffic Patterns
post
Volume Analyzer
Retrieve Analysis Data Sample Sizes
get
Retrieve Anomaly Scores
get
Execute Volume Analyzer
post
Retrieve History Years
get
Volume Budget
Import Volume Budgets
post
Retrieve Volume Budgets
post
Volume Forecast
Update Volume Forecast
put
Import Volume Forecast (Deprecated)
post
Retrieve Volume Forecasts
post
Restore Volume Forecast
post
Import Volume Forecast
post
Volume Forecast Engine
Execute Volume Forecast Engine
post
Retrieve Volume Forecast Engine Status
post
Volume Forecast Intervals Engine
Execute Volume Forecast Intervals Engine
post
Volume Forecasts
Retrieve Multiple Volume Forecasts
post
Week Symbolic Periods
Retrieve Week Symbolic Period Types (Deprecated)
get
Retrieve Week Symbolic Period Types
get
Healthcare Productivity
Billing Department and Work Unit Maps
Retrieve All Billing Department and Work Unit Maps
get
Create or Update Billing Department and Work Unit Maps
post
Charge Masters
Retrieve All Charge Masters
get
Create or Update Charge Masters
post
Retrieve Volume Labels
post
Labor Type Agency Recalculation
Recalculate Agency Asynchronously
post
Retrieve Agency Recalculation Asynchronous Request Status by Execution Key
get
Payroll Data Enrichment
Enrich Payroll Data
post
Payroll Department to Work Unit Maps
Retrieve Payroll Department to Work Unit Maps
get
Create or Update Payroll Department to Work Unit Maps
post
Payroll Employment Status to Labor Type Maps
Retrieve Payroll Employment Status to Labor Type Maps
get
Create or Update Payroll Employment Status to Labor Type Maps
post
Payroll Job Maps
Retrieve Payroll Job Maps
get
Create or Update Payroll Job Maps
post
Raw Volume
Create or Update Raw Volume
post
Raw Volume Data Errors
Retrieve All Raw Volume Error Records
get
Create or Update Raw Volume Error Records
post
Volume Copy Maps
Retrieve All Volume Copy Maps
get
Create or Update Volume Copy Maps
post
Volume Copy Override Maps
Retrieve All Volume Copy Override Maps
get
Create or Update Volume Copy Override Maps
post
Volume Process Status
Retrieve Volume Process Status by Key
get
Volume Recalculation
Recalculate Volume
post
Work Unit Hyperfind Profiles
Retrieve All Work Unit Hyperfind Profiles
get
Create or Update Work Unit Hyperfind Profiles
post
Work Unit Hyperfinds
Retrieve Work Unit Hyperfinds
get
Execute Work Unit Hyperfind
post
Create or Update Work Unit Hyperfinds
post
Work Unit Locations
Retrieve Work Unit Locations
post
Work Units
Retrieve All Work Units
get
Create or Update Work Units
post
Human Capital Management
HCM Payroll Aggregation
Retrieve Payroll Data for HCM
post
People Profiles
Retrieve All People Profiles
get
Retrieve People Profiles
post
Retrieve People Profile by ID
get
Profile Field Maps
Retrieve All Profile Field Maps
get
Retrieve Profile Field Maps
post
Create or Update Profile Field Maps
post
Profile Templates
Retrieve All Profile Templates
get
Retrieve Profile Templates
post
Retrieve Profile Template by ID
get
Leave
Employee Schedules for Leave
Retrieve Employee Schedule for Leave
get
Leave Audit Records
Retrieve Leave Audit Records
post
Leave Case Certifications
Retrieve Leave Case Certification History
get
Create Leave Case Certification
post
Leave Case Custom Fields
Retrieve Custom Fields
get
Update Custom Fields
post
Leave Case Defaults
Retrieve Leave Case Defaults
get
Update Leave Case Defaults
put
Retrieve Leave Case Defaults by ID
get
Leave Case Documents
Retrieve Documents
get
Generate Documents
post
Update Documents
post
Leave Case Eligibility Requirements
Retrieve Eligibility Requirements
get
Update Eligibility Requirements
post
Leave Case Notes
Retrieve Leave Case Notes
get
Create Leave Case Note
post
Delete Leave Case Note by ID
delete
Retrieve Leave Case Note by ID
get
Update Leave Case Note by ID
post
Leave Case Notifications
Retrieve Leave Case Notifications
get
Create Leave Case Notification
post
Delete Leave Case Notification by ID
delete
Retrieve Leave Case Notification by ID
get
Update Leave Case Notification by ID
post
Activate Leave Case Notification by ID
post
Copy Leave Case Notification by ID
post
Deactivate Leave Case Notification by ID
post
Leave Case Rules
Retrieve Rule Assignments
get
Create Rule Assignment
post
Delete Rule Assignment
delete
Retrieve Rule Assignment
get
Update Rule Assignment
post
Leave Case Statuses
Retrieve Leave Case Statuses (Deprecated)
get
Retrieve Leave Case Statuses
get
Leave Cases
Delete Leave Case
delete
Retrieve Leave Case Details
get
Create Leave Case
post
Update Leave Case
put
Execute Grant Leave
post
Retrieve Grant Data
get
Create Multiple Leave Cases
post
Retrieve Leave Cases
post
Retrieve Total Taking Amount
get
Retrieve Leave Case Details by ID
get
Update Leave Types for Leave Case
put
Leave Categories
Retrieve All Leave Categories or by Name
get
Retrieve Leave Categories
post
Retrieve Leave Category by ID
get
Leave Custom Fields
Retrieve Leave Custom Fields by Type
get
Leave Edits
Create Leave Edits
post
Delete Leave Edits
post
Retrieve Leave Edits
post
Leave Events
Retrieve Leave Events
post
Leave Profiles
Retrieve All Leave Profiles
get
Retrieve Leave Profile by ID
get
Leave Reasons
Retrieve All Leave Reasons or by Name
get
Retrieve Leave Reasons
post
Retrieve Leave Reason by ID
get
Leave Request Configuration
Retrieve Leave Request Configuration
get
Retrieve Leave Request Subtypes
get
Leave Requests
Create Leave Request
post
Process Leave Requests
post
Create Leave Case Requests
post
Retrieve Leave Case Requests
post
Process Leave Request by ID
post
Leave Rules
Retrieve Available Rules
get
People
Employee Glance Setting Resources
Retrieve All Custom Fields
get
Employee Glance Settings
Retrieve All Employee Glance Settings or by Name
get
Create Employee Glance Setting
post
Delete Employee Glance Settings
post
Retrieve Employee Glance Settings
post
Create or Update Employee Glance Settings
post
Delete Employee Glance Setting by ID
delete
Retrieve Employee Glance Setting by ID
get
Update Employee Glance Setting by ID
put
Employee Wage Work Rules
Retrieve Employee Wage and Work Rules
post
Create or Update Wage and Work Rule Overrides
post
People Information Profiles
Retrieve All People Information Profiles
get
Retrieve People Information Profiles
post
Retrieve People Information Profile by ID
get
Persons
Create Person
post
Retrieve All Persons
post
Retrieve Base Person
post
Retrieve Current User's Delegations
get
Retrieve Current User
get
Retrieve All Extensions
get
Retrieve Persons
post
Create Multiple Persons
post
Delete Multiple Persons
post
Update Multiple Persons
post
Create or Update Persons
post
Retrieve Punch Interpretation Rule
get
Retrieve Employee References
post
Retrieve Person by Extension
get
Delete Person by ID
delete
Retrieve Person by ID
get
Update Person by ID
put
Person Assignments
Adjustment Rule Assignments
Delete Adjustment Rule Assignment
delete
Retrieve Adjustment Rule Assignments by Person Number
get
Create Adjustment Rule Assignment
post
Update Adjustment Rule Assignment
put
Create Adjustment Rule Assignments
post
Delete Adjustment Rule Assignments
post
Retrieve All Adjustment Rules (Deprecated)
get
Retrieve Adjustment Rules-Multiple Employees
post
Update Adjustment Rule Assignments
post
Retrieve Adjustment Rule Assignments by ID
get
Aggregated Person Assignments
Retrieve All Assignments by Criteria
get
Retrieve All Assignments for Multiple People
post
Modify Assignments for Multiple People
post
Retrieve All Assignment Names
get
Retrieve All Assignments by Person ID
get
Attendance Administrator Assignment
Delete Attendance Admin
delete
Retrieve Attendance Admin by Person Number
get
Update Attendance Admin
put
Delete Attendance Admin for Multiple Employees
post
Retrieve Attendance Admin for Multiple Employees
post
Update Attendance Admin for Multiple Employees
post
Retrieve Attendance Admin by Person ID
get
Attendance Profile Assignments
Retrieve Attendance Profile by Person Number
get
Update Attendance Profile
put
Retrieve Attendance Profile for Multiple Employees
post
Update Attendance Profile for Multiple Employees
post
Retrieve Attendance Profile by Person ID
get
Attestation Profile Assignments
Retrieve Assigned Attestation Profiles
get
Assign Attestation Profile
post
Attestation Profile Assignments by Person Number
Retrieve Assigned Attestation Profiles by Person Number
get
Assign Attestation Profile by Person Number
post
Retrieve Attestation Profile Assignments by Person Number
post
Update Attestation Profile Assignments by Person Number
post
Brazil Employee Assignments
Retrieve Brazil Employee Assignments by Person ID or Number
get
Retrieve Brazil Employee Assignments
post
Add or Update Brazil Employee Assignments
post
Retrieve Brazil Employee Assignments by Person ID
get
Cascade Profile Assignments
Delete Cascade Profile
delete
Retrieve Cascade Profiles by Person Number
get
Assign Cascade Profile
put
Delete Cascade Profiles for Multiple Employees
post
Retrieve Cascade Profiles for Multiple Employees
post
Assign Cascade Profiles to Multiple Employees
post
Retrieve Cascade Profiles by Person ID
get
Certification Assignments
Retrieve Certification Assignments by Person Number
get
Delete Certification Assignments
post
Retrieve All Certification Assignments
post
Update Certification Assignments
post
Retrieve Certification Assignments by ID
get
Update Certification Assignment by ID
put
Direct Assignments
Retrieve All People Direct Assignment Profiles
get
Employee Job Preferences
Retrieve Job Preferences by Person Number
get
Update Job Preferences
put
Retrieve Job Preferences for Multiple Employees
post
Update Job Preferences for Multiple Employees
post
Retrieve Job Preferences by ID
get
Employee Tag Assignments
Retrieve Employee Tag Assignments by Person Number
get
Create Employee Tag Assignments
post
Create, Update, or Remove Employee Tag Assignments
put
Delete Employee Tag Assignments
post
Create Employee Tag Assignments for Multiple Employees
post
Delete Employee Tag Assignments for Multiple Employees
post
Retrieve Employee Tag Assignments for Multiple Employees
post
Create, Update, or Remove Employee Tag Assignments for Multiple Employees
post
Retrieve Employee Tag Assignments by Person ID
get
Employment Term Assignments
Retrieve Employment Term Assignment by Person Number
get
Create Employment Term Assignment
post
Update Employment Term Assignment
put
Delete Employment Term Assignment
post
Create Employment Term Assignments
post
Delete Employment Term Assignments
post
Retrieve Employment Term Assignments
post
Update Employment Term Assignments
post
Retrieve Employment Term Assignment by ID
get
Forecasting Category Profile Assignments
Delete Category Profile Assignment
delete
Retrieve Category Profile Assignment by Person Number
get
Create or Update Category Profile Assignment
put
Delete Category Profile Assignments
post
Retrieve Category Profile Assignments
post
Update Category Profile Assignments
post
Retrieve Category Profile Assignment by Person Key
get
Leave Administrator Assignment
Delete Leave Admin
delete
Retrieve Leave Admin by Person Number
get
Update Leave Admin
put
Delete Leave Admin for Multiple Employees
post
Retrieve Leave Admin for Multiple Employees
post
Update Leave Admin for Multiple Employees
post
Retrieve Leave Admin by Person ID
get
Leave Profile Assignments
Delete Leave Profile Assignment
delete
Retrieve Leave Profile Assignment by Person Number
get
Update Leave Profile Assignment
put
Delete Leave Profile Assignments
post
Retrieve Leave Profile Assignments
post
Update Leave Profile Assignments
post
Retrieve Leave Profile Assignment by Person ID
get
Manager Role Assignments
Retrieve Manager Role Assignments by Person Number
get
Create, Update, or Delete Manager Role Assignments
post
Retrieve Manager Role Assignments
post
Update Manager Role Assignments
post
Retrieve Manager Role Assignments by ID
get
Minor Rule and School Calendar Assignments
Retrieve Minor Rule and School Calendar Assignments by Person Number (Deprecated)
get
Update Minor Rule and School Calendar Assignments by ID (Deprecated)
put
Retrieve Minor Rule and School Calendar Assignments (Deprecated)
post
Update Minor Rule and School Calendar Assignments (Deprecated)
post
Retrieve Minor Rule and School Calendar Assignments by ID (Deprecated)
get
Retrieve Minor Rule and School Calendar Assignments by Person Number
get
Retrieve Minor Rule and School Calendar Assignments
post
Update Minor Rule and School Calendar Assignments
post
Retrieve Minor Rule and School Calendar Assignments by ID
get
Update Minor Rule and School Calendar Assignments by ID
put
Pattern Template Profile Assignments
Retrieve Pattern Template Profile Assignments by Person Number
get
Delete Pattern Template Profile Assignments
post
Retrieve Pattern Template Profile Assignments
post
Update Pattern Template Profile Assignments
post
Delete Pattern Template Profile Assignment by Person ID
delete
Retrieve Pattern Template Profile Assignments by Person ID
get
Update Pattern Template Profile Assignment by Person ID
put
Paycode Value Profile Assignments
Retrieve Paycode Value Profile Assignment by Person Number (Deprecated)
get
Delete Paycode Value Profile Assignments (Deprecated)
post
Retrieve All Paycode Value Profile Assignments (Deprecated)
post
Update Paycode Value Profile Assignments (Deprecated)
post
Delete Paycode Value Profile Assignment by ID (Deprecated)
delete
Retrieve Paycode Value Profile Assignment by ID (Deprecated)
get
Update Paycode Value Profile Assignment (Deprecated)
put
Retrieve Paycode Value Profile Assignment by Person Number
get
Delete Paycode Value Profile Assignments
post
Retrieve Paycode Value Profile Assignments
post
Update Paycode Value Profile Assignments
post
Delete Paycode Value Profile Assignment by ID
delete
Retrieve Paycode Value Profile Assignment by ID
get
Update Paycode Value Profile Assignment by ID
put
Percentage Allocation Rule Assignments
Delete Percentage Allocation Rule
delete
Retrieve Percentage Allocation Rule Assignments by Person Number
get
Assign Percentage Allocation Rule
post
Update Percentage Allocation Rule Assignment by ID
put
Assign Percentage Allocation Rule to Multiple Employees
post
Delete Percentage Allocation Rule Assignments
post
Retrieve All Percentage Allocation Rule Assignments
get
Retrieve Percentage Allocation Rules Assignments
post
Update Percentage Allocation Rule Assignments
post
Retrieve Percentage Allocation Rules Assignments by ID
get
Person Common ID
Delete AOID and COID
delete
Retrieve AOID and COID by Person Number
get
Add or Update AOID and COID
put
Retrieve Persons without an Assigned AOID
post
Delete AOID and COID for Multiple Employees
post
Retrieve AOID and COID for Multiple Employees
post
Update AOID and COID for Multiple Employees
post
Retrieve AOID and COID by Person ID
get
Person TeleStaff Assignments
Retrieve Person TeleStaff Assignment by Person Number
get
Create Person TeleStaff Assignment by Person Number
post
Create Person TeleStaff Assignments by Person Number for Multiple Employees
post
Delete Person TeleStaff Assignments for Multiple Employees
post
Retrieve Person TeleStaff Assignments for Multiple Employees
post
Update Person TeleStaff Assignments for Multiple Employees
post
Delete Person TeleStaff Assignment by ID
delete
Retrieve Person TeleStaff Assignment by ID
get
Update Person TeleStaff Assignment by ID
put
Process Profile Assignments
Retrieve Process Profile by Person Number
get
Retrieve Process Profiles for Multiple Employees
post
Update Process Profile for Multiple Employees
post
Update Process Profile
put
Retrieve Process Profile by Person ID
get
Schedule Group Assignments
Retrieve Group Memberships by Person Number
get
Add Group Memberships-One Employee
post
Update Group Memberships-One Employee
put
Remove Group Memberships-One Employee
post
Add Group Memberships-Multiple Employees
post
Remove Group Memberships-Multiple Employees
post
Retrieve Group Memberships-Multiple Employees
post
Update Group Memberships-Multiple Employees
post
Retrieve Group Memberships by ID
get
Schedule Group Profile Assignments
Retrieve Schedule Group Profile Assignments by Person Number
get
Delete Schedule Group Profile Assignments
post
Retrieve Schedule Group Profile Assignments
post
Update Schedule Group Profile Assignments
post
Delete Schedule Group Profile Assignments by Person ID
delete
Retrieve Schedule Group Profile Assignments by Person ID
get
Update Schedule Group Profile Assignment by Person ID
put
Schedule Override Employee Preferences
Retrieve Schedule Override Employee Preferences by Person Number
get
Retrieve Schedule Override Employee Preferences
post
Create or Update Schedule Override Employee Preferences
post
Retrieve Schedule Override Employee Preferences by Person ID
get
Update Schedule Override Employee Preferences by Person ID
put
Schedule Rule Overrides
Retrieve All Schedule Rule Overrides or by Person Number (Deprecated)
get
Create Schedule Rule Override
post
Update Schedule Rule Override
put
Create Schedule Rule Overrides
post
Delete Schedule Rule Overrides
post
Retrieve Schedule Rule Overrides (Deprecated)
post
Update Schedule Rule Overrides
post
Retrieve Schedule Rule Override by ID (Deprecated)
get
Delete Schedule Rule Override by ID
delete
Retrieve All Schedule Rule Overrides or by Person Number
get
Retrieve Schedule Rule Overrides
post
Retrieve Schedule Rule Override by ID
get
Schedule Rule Set Assignments
Retrieve Rule Set Assignments
get
Retrieve Rule Set Assignments for Multiple Employees
post
Update Rule Set Assignments for Multiple Employees
post
Update Rule Set Assignments by ID
put
Scheduling Employee Preferences
Retrieve Employee Preferences by Person Number (Deprecated)
get
Update Employee Preferences by ID
put
Retrieve Employee Preferences (Deprecated)
post
Update Employee Preferences
post
Retrieve Employee Preferences by ID (Deprecated)
get
Retrieve Employee Preferences by Person Number
get
Retrieve Employee Preferences
post
Retrieve Employee Preferences by ID
get
School Calendar Profile Assignments
Retrieve School Calendar Profile Assignment by Person Number
get
Delete School Calendar Profile Assignments
post
Retrieve School Calendar Profile Assignments
post
Update School Calendar Profile Assignments
post
Delete School Calendar Profile Assignment by Person ID
delete
Retrieve School Calendar Profile Assignment by Person ID
get
Update School Calendar Profile Assignment by Person ID
put
Shift Template Profile Assignments
Retrieve Shift Template Profile Assignments by Person Number
get
Delete Shift Template Profile Assignments
post
Retrieve Shift Template Profile Assignments
post
Update Shift Template Profile Assignments
post
Delete Shift Template Profile Assignment by Person ID
delete
Retrieve Shift Template Profile Assignments by Person ID
get
Update Shift Template Profile Assignment by Person ID
put
Skill Assignments
Retrieve Skill Assignments by Person Number
get
Delete Skill Assignments
post
Retrieve All Skill Assignments
post
Update Skill Assignments
post
Retrieve Skill Assignments by ID
get
Update Skill Assignment by ID
put
Supervisor Assignments
Retrieve Supervisor Assignments for Multiple Employees
post
Add or Update Supervisor Assignment for Multiple Employees
post
Retrieve Supervisor Assignments by Person ID
get
Worker Type Assignments
Retrieve Worker Type Assignment by Person Number
get
Delete Worker Type Assignments
post
Retrieve Worker Type Assignments
post
Update Worker Type Assignments
post
Delete Worker Type Assignment by Person ID
delete
Retrieve Worker Type Assignment by Person ID
get
Update Worker Type Assignment by Person ID
put
Platform
API Integrations
Retrieve API Integrations
get
Execute API Integration by Key
post
Retrieve Integration Status by ID
get
Retrieve API Integration by Key
get
Action Templates
Retrieve All Announcement Action Templates
get
Retrieve Announcement Action Template by ID
get
Batch Event Scheduling
Schedule Batch Events
post
Batch Events
Retrieve All Batch Events
get
Update Batch Events
post
Create Batch Events
post
Delete Batch Events
post
Delete Batch Event by ID
delete
Retrieve Batch Event by ID
get
Update Batch Events by ID
put
Retrieve Batch Tasks by Batch Event ID
get
Batch Groups
Retrieve All Batch Groups
get
Update Batch Groups
post
Create Batch Groups
post
Delete Batch Groups
post
Delete Batch Group by ID
delete
Retrieve Batch Group by ID
get
Update Batch Group by ID
put
Retrieve Batch Events by Batch Group ID
get
Batch Job Statuses
Retrieve Batch Job Statuses
post
Batch Job Statuses with Pagination
Retrieve Batch Job Statuses with Pagination
post
Batch Tasks
Retrieve All Batch Tasks
get
Update Batch Tasks
post
Create Batch Tasks
post
Delete Batch Tasks
post
Retrieve All Batch Task Action Types
get
Delete Batch Task by ID
delete
Retrieve Batch Task by ID
get
Update Batch Task by ID
put
Change Indicators
Retrieve Marker Types
get
Retrieve Marker Events
post
Retrieve Subscriptions
get
Subscribe or Unsubscribe to Change Indicators
post
Employee Announcements
Update Announcement Message Response as Employee
post
Retrieve Announcement Message Response by ID as Employee
get
File-based Integrations
Retrieve Integrations
get
Create an Integration Process
post
Delete Integration by ID
delete
Retrieve Integration Process by ID
get
Update Integration by ID
put
Execute Integration by ID
post
Schedule Integration by ID
post
Integration Executions
Retrieve All Integration Executions
get
Retrieve Integration Executions
post
Retrieve Integration Execution by ID
get
Submit Integration Execution Additional Details
post
Download File by Integration
get
Retrieve File Names by Integration ID
get
Integration List Parameters
Create or Update Integration List Parameters
post
Retrieve Integration List Parameter by Name
get
Integration Process Callback
Update Integration Execution Details
post
Integration Schedules
Retrieve All Scheduled Integration Instances
get
Delete Scheduled Integration Instance by ID
delete
Retrieve Scheduled Integration Instance by ID
get
Update Scheduled Integration Instance by ID
put
Kiosk
Retrieve Kiosk Login Transactions
post
Retrieve All Kiosk Instances
get
Create Kiosk Instance
post
Delete Kiosk Instance by ID
delete
Retrieve Kiosk Instance by ID
get
Update Kiosk Instance by ID
put
Retrieve All Kiosk Configurations
get
Create Kiosk Configuration
post
Delete Kiosk Configuration by ID
delete
Retrieve Kiosk Configuration by ID
get
Update Kiosk Configuration by ID
put
Manager Announcements
Create Announcement as Manager
post
Retrieve Announcement Messages as Manager
post
Retrieve Announcement Message Response by ID as Manager
get
Mapping Categories
Retrieve All Mapping Categories
get
Create Mapping Category
post
Retrieve Mapping Category by ID
get
Update Mapping Category by ID
put
Mapping Category Types
Retrieve All Mapping Category Types or by Name
get
Retrieve Mapping Category Type by ID
get
Menu Items
Retrieve All Menu Items
get
Messaging with Generic Notifications
Retrieve Generic Notifications for Messaging
get
Send Notification by Event Type
post
Retrieve Generic Notification by ID for Messaging
get
Send Notification by ID
post
Publish and Run Reports
Retrieve Published Reports
get
Save Report
post
Save Report Asynchronously
post
Retrieve Payroll Staging Asynchronous Request Status by Key
get
Delete Report
delete
Retrieve Report by ID
get
Update Report by ID
post
Run Report by Name
post
Retrieve Report by Name
get
Report Categories
Get All Report Categories
get
Get Report Category By Name
get
Report Data Objects
Retrieve All Report Data Objects or by Name
get
Create Report Data Object
post
Retrieve Report Data Element Definitions
post
Retrieve Report Data Object by ID
get
Update Report Data Object by ID
put
Retrieve Report Data Object by Name
post
Generate Report Data Object Batched Requests by Name
post
Report Designs
Retrieve All Report Designs
get
Delete Unpublished Report Design by ID
delete
Retrieve a Report Design by Name
get
Retrieve Report Design Parameters
get
Report Executions
Retrieve Report History (Deprecated)
get
Retrieve Report History by Criteria
post
Retrieve Report Execution Status by ID
get
Retrieve Executed Report Output by ID
get
Report Profiles
Retrieve All Report Profiles
get
Create Report Profile
post
Delete Report Profile by ID
delete
Retrieve Report Profile by ID
get
Update Report Profile by ID
put
Report Requests
Retrieve Scheduled Report Requests (Deprecated)
get
Create Report Request
post
Retrieve Paginated List of Scheduled Report Requests
post
Delete Report Request by ID
delete
Update Report Request by ID
put
SFTP Connections
Retrieve All SFTP Connections
get
Update SFTP Connections for Integrations
post
Retrieve SFTP Connection by ID
get
Test SFTP Connection by ID
get
Switch Employment
Switch Employment
post
Target Threshold Evaluation Period
Retrieve Target Threshold Evaluation Period
get
Target Threshold Indicator Texts
Retrieve All Target Threshold Indicator Texts
get
Target Threshold Metric Sets
Retrieve All Target Threshold Metric Sets
get
Target Threshold Operators
Retrieve All Target Threshold Operators
get
Target Thresholds
Retrieve Target Thresholds by Criteria
get
Create Target Threshold
post
Export Target Threshold Data
get
Retrieve Target Thresholds
post
Create or Update Target Thresholds
post
Retrieve Target Short Names
get
Delete an expired HCA Target Threshold by ID
delete
Retrieve Target Threshold by ID
get
Update a Target Threshold by ID
put
Tenant Information
Retrieve Tenant Information
get
Workflow Business Processes
Retrieve Business Process
get
Execute Business Process
post
Submit Business Process Form Data
post
Scheduling Setup
Absence Quota Overrides
Retrieve Absence Quota Overrides
post
Create, Update, or Delete Absence Quota Overrides
post
Calendar Profiles
Retrieve All Calendar Profiles or by Name
get
Retrieve Calendar Profiles
post
Retrieve Calendar Profile by ID
get
Certifications Setup
Retrieve All Certifications or by Name
get
Create Certification
post
Create Certifications
post
Delete Certifications
post
Retrieve Certifications
post
Update Certifications
post
Delete Certification by ID
delete
Retrieve Certification by ID
get
Update Certification by ID
put
Coverage Counting Profiles
Retrieve All Coverage Counting Profiles or by Name
get
Retrieve Coverage Counting Profile Assignment
get
Retrieve Coverage Counting Profile Assignments
post
Retrieve Coverage Counting Profiles
post
Retrieve Coverage Counting Profile by ID
get
Day Type Equivalencies
Retrieve All Day Type Equivalencies or by Name
get
Retrieve All Day Type Equivalencies
post
Retrieve Day Type Equivalence by ID
get
ESS Calendar Settings
Retrieve ESS Calendar Settings by Name
get
Create ESS Calendar Settings
post
Create Multiple ESS Calendar Settings
post
Delete Multiple ESS Calendar Settings
post
Retrieve Multiple ESS Calendar Settings
post
Update Multiple ESS Calendar Settings
put
Retrieve All Schedule Insights Widget Entities
get
Retrieve Transfer Types for ESS Calendar Settings
get
Delete ESS Calendar Settings by ID
delete
Retrieve ESS Calendar Settings by ID
get
Update ESS Calendar Settings
put
Employee Visibility Periods
Retrieve All Employee Visibility Periods or by Name
get
Retrieve Eligible Submission Periods
post
Retrieve Employee Visibility Periods
post
Retrieve Employee Visibility Period by ID
get
Holiday and Unscheduled Day Request Settings
Retrieve Holiday and Unscheduled Day Request Settings by Specification
get
Create Holiday and Unscheduled Day Request Settings
post
Create Multiple Holiday and Unscheduled Day Request Settings
post
Delete Multiple Holiday and Unscheduled Day Request Settings
post
Retrieve Holiday and Unscheduled Day Request Settings by Object Refs
post
Update Multiple Holiday and Unscheduled Day Request Settings
post
Delete Holiday and Unscheduled Day Request Settings by ID
delete
Retrieve Holiday and Unscheduled Day Request Settings by ID
get
Update Holiday and Unscheduled Day Request Settings by ID
put
Indicators
Retrieve All Indicators or by Name
get
Retrieve Indicators
post
Retrieve Indicator by ID
get
Location Profiles Option Sets
Retrieve All Location Profiles Option Sets or by Name
get
Retrieve Location Profile Option Set Assignment
get
Retrieve Location Profiles Option Set Assignments
post
Retrieve Location Profiles Option Sets
post
Retrieve Location Profiles Option Set by ID
get
Minor Rule Sets
Retrieve All Minor Rules or by Name
get
Retrieve Minor Rules
post
Retrieve Minor Rule by ID
get
Occurrence Definitions
Retrieve All Occurrence Definitions or by Name
get
Create Occurrence Definition
post
Create Occurrence Definitions
post
Delete Occurrence Definitions
post
Retrieve Occurrence Definitions
post
Update Occurrence Definitions
post
Delete Occurrence Definition by ID
delete
Retrieve Occurrence Definition by ID
get
Update Occurrence Definition by ID
put
Partial Shift Settings
Retrieve Partial Shift Settings by Name
get
Create Partial Shift Settings
post
Create Multiple Partial Shift Settings
post
Delete Multiple Partial Shift Settings
post
Retrieve Multiple Partial Shift Settings
post
Update Multiple Partial Shift Settings
post
Delete Partial Shift Settings by ID
delete
Retrieve Partial Shift Settings by ID
get
Update Partial Shift Settings by ID
put
Pattern Template Profiles
Retrieve All Pattern Template Profiles
get
Paycode Value Profiles
Retrieve Paycode Value Profile by Name
get
Create Paycode Value Profile
post
Create Paycode Value Profiles
post
Delete Paycode Value Profiles
post
Retrieve All Paycode Value Profiles
post
Update Paycode Value Profiles
post
Delete Paycode Value Profile by ID
delete
Retrieve Paycode Value Profile by ID
get
Update Paycode Value Profile by ID
put
Period Definitions
Retrieve All Period Definitions or by Name
get
Create Period Definition
post
Create Period Definitions
post
Delete Period Definitions
post
Retrieve Period Definitions
post
Update Period Definitions
put
Delete Period Definition by ID
delete
Retrieve Period Definition by ID
get
Update Period Definition by ID
put
Predictive Scheduling
Retrieve Predictive Scheduling Violations
post
Retrieve Predictive Scheduling Violations, Hours, and Costs
post
Predictive Scheduling Bonus
Retrieve Predictive Scheduling Bonus by name
get
Create Predictive Scheduling Bonus
post
Create Multiple Predictive Scheduling Bonuses
post
Delete Multiple Predictive Scheduling Bonuses
post
Retrieve Predictive Scheduling Bonuses
post
Update Multiple Predictive Scheduling Bonuses
post
Delete Predictive Scheduling Bonus by ID
delete
Retrieve Predictive Scheduling Bonus by ID
get
Update Predictive Scheduling Bonus by ID
put
Predictive Scheduling Rules
Retrieve Predictive Scheduling Rule by name
get
Create Predictive Scheduling Rule
post
Create Multiple Predictive Scheduling Rules
post
Delete Multiple Predictive Scheduling Rules
post
Retrieve Predictive Scheduling Rules
post
Update Multiple Predictive Scheduling Rules
post
Delete Predictive Scheduling Rule by ID
delete
Retrieve Predictive Scheduling Rule by ID
get
Update Predictive Scheduling Rule by ID
put
Procedure Sets
Retrieve Procedure Set by Name
get
Retrieve Procedure Sets
post
Retrieve Procedure Set by ID
get
Proficiency Levels
Retrieve Proficiency Level by Name
get
Create Proficiency Level
post
Create Proficiency Levels
post
Delete Proficiency Levels
post
Retrieve Proficiency Levels
post
Update Proficiency Levels
post
Retrieve Proficiency Level by ID
get
Delete Proficiency Level by ID
delete
Update Proficiency Level by ID
put
Request Submission Periods
Verify Request Item Periods
post
Open Next Submission Period
post
Request Subtypes
Retrieve Request Subtype by Name
get
Retrieve Request Subtypes
post
Retrieve Request Subtype by ID
get
Schedule Builder Settings
Retrieve Schedule Builder Settings
get
Retrieve Schedule Builder Settings by ID
get
Update Schedule Builder Settings by ID
put
Schedule Change Criteria
Retrieve Schedule Change Criteria by Name
get
Create Schedule Change Criteria
post
Create Multiple Schedule Change Criteria
post
Delete Multiple Schedule Change Criteria
post
Retrieve Multiple Schedule Change Criteria
post
Update Multiple Schedule Change Criteria
post
Delete Schedule Change Criteria by ID
delete
Retrieve Schedule Change Criteria by ID
get
Update Schedule Change Criteria by ID
post
Schedule Event Rules
Retrieve All Schedule Event Rules or by Name
get
Create Schedule Event Rule
post
Create Schedule Event Rules
post
Delete Schedule Event Rules
post
Retrieve Schedule Event Rules
post
Update Schedule Event Rules
post
Delete Schedule Event Rule by ID
delete
Retrieve Schedule Event Rule by ID
get
Update Schedule Event Rule by ID
put
Schedule Events
Retrieve Schedule Event by Name
get
Create Schedule Event
post
Create Schedule Events
post
Delete Schedule Events
post
Retrieve Schedule Events
post
Update Schedule Events
post
Delete Schedule Event by ID
delete
Retrieve Schedule Event by ID
get
Update Schedule Event by ID
put
Schedule Groups
Retrieve All Schedule Groups or by Name (Deprecated)
get
Retrieve Schedule Groups (Deprecated)
post
Retrieve Schedule Group by ID (Deprecated)
get
Retrieve All Schedule Groups or by Name
get
Create Schedule Group
post
Create Schedule Groups
post
Delete Schedule Groups
post
Retrieve Schedule Groups
post
Update Schedule Groups
post
Delete Schedule Group by ID
delete
Retrieve Schedule Group by ID
get
Update Schedule Group by ID
put
Schedule Patterns
Delete Schedule Pattern by Name
delete
Retrieve Schedule Pattern by Name
get
Create Schedule Pattern
post
Update Schedule Pattern by Name
put
Create Schedule Patterns
post
Delete Schedule Patterns
post
Retrieve Schedule Patterns
post
Update Schedule Patterns
put
Delete Schedule Pattern by ID
delete
Retrieve Schedule Pattern by ID
get
Update Schedule Pattern by ID
put
Schedule Periods
Retrieve All Schedule Periods
get
Retrieve Schedule Periods
post
Retrieve Schedule Period by ID
get
Schedule Rule Set Location Assignments
Retrieve All Rule Set Location Assignments
get
Create or Update Rule Set Location Assignment
put
Delete Rule Set Location Assignments by Rule Set
post
Delete Rule Set Location Assignments
post
Create or Update Rule Set Location Assignments
post
Delete Rule Set Location Assignment by ID
delete
Retrieve Rule Set Location Assignment by ID
get
Schedule Rule Sets
Retrieve All Rule Sets or by Name
get
Create Rule Set
post
Retrieve Rule Sets
post
Retrieve Rule Set by ID
get
Delete Rule Set by ID
delete
Update Rule Set by ID
put
Schedule Rules
Retrieve All Schedule Rules or by Name
get
Retrieve Schedule Rules
post
Retrieve Schedule Rule by ID
get
Schedule Score Definitions
Retrieve All Schedule Score Definitions or by Name
get
Create Schedule Score Definition
post
Create Schedule Score Definitions
post
Delete Schedule Score Definitions
post
Retrieve Schedule Score Definitions
post
Update Schedule Score Definitions
post
Delete Schedule Score Definition by ID
delete
Retrieve Schedule Score Definition by ID
get
Update Schedule Score Definition by ID
put
Schedule Score Factors
Retrieve All Schedule Score Factors
get
Retrieve Schedule Score Factor by ID
get
Update Schedule Score Factor by ID
put
Schedule Zone Sets
Retrieve All Schedule Zone Sets or by Name
get
Retrieve Schedule Zone Set Assignments
post
Retrieve Schedule Zone Sets
post
Retrieve Schedule Zone Set by ID
get
School Calendar Profiles
Retrieve All Active School Calendar Profiles
get
School Calendars
Retrieve All School Calendars or by Name
get
Retrieve School Calendars
post
Retrieve School Calendar by ID
get
Shift Template Profiles
Retrieve All Shift Template Profiles or by Name
get
Create Shift Template Profile
post
Create Shift Template Profiles
post
Delete Shift Template Profiles
post
Retrieve Shift Template Profiles
post
Update Shift Template Profiles
post
Delete Shift Template Profile by ID
delete
Retrieve Shift Template Profile by ID
get
Update Shift Template Profile by ID
put
Shift Templates
Retrieve Shift Template by Name
get
Create Shift Template
post
Retrieve or Create Shift Templates
post
Create Shift Templates
post
Delete Shift Templates
post
Retrieve Shift Templates
post
Update Shift Templates
put
Delete Shift Template by ID
delete
Retrieve Shift Template by ID
get
Update Shift Template by ID
put
Skills Setup
Retrieve All Skills or by Name
get
Create Skill
post
Create Skills
post
Delete Skills
post
Retrieve Skills
post
Update Skills
post
Delete Skill by ID
delete
Retrieve Skill by ID
get
Update Skill by ID
put
Staffing Dashboard Settings
Retrieve All Staffing Dashboard Settings or by Name
get
Create Staffing Dashboard Settings
post
Retrieve All Colorized Entities
get
Retrieve All Employee Pool Additional Data Entities
get
Create Multiple Staffing Dashboard Settings
post
Delete Staffing Dashboard Settings
post
Retrieve Staffing Dashboard Settings
post
Update Staffing Dashboard Settings
post
Retrieve Schedule Change Notification Options
get
Retrieve All Unit Panel Additional Data Entities
get
Delete Staffing Dashboard Settings by ID
delete
Retrieve Staffing Dashboard Settings by ID
get
Update Staffing Dashboard Settings by ID
put
Staffing Matrices
Retrieve All Staffing Matrices or by Name
get
Create Staffing Matrix
post
Create Staffing Matrices
post
Delete Staffing Matrices
post
Retrieve Staffing Matrices
post
Update Staffing Matrices
post
Delete Staffing Matrix by ID
delete
Retrieve Staffing Matrix by ID
get
Update Staffing Matrix by ID
put
Staffing Profiles
Retrieve All Staffing Profiles or by Name
get
Create Staffing Profile
post
Create Staffing Profiles
post
Delete Staffing Profiles
post
Retrieve Staffing Profiles
post
Update Staffing Profiles
post
Delete Staffing Profile by ID
delete
Retrieve Staffing Profile by ID
get
Update Staffing Profile by ID
put
Standard Shift Set Assignments
Delete Standard Shift Set Location Assignments by Shift Set
post
Retrieve Standard Shift Set Location Assignments with Locations
post
Delete Standard Shift Set Location Assignments
post
Retrieve Shift Set Assignments
post
Create or Update Standard Shift Set Location Assignments
post
Standard Shift Sets
Retrieve All Standard Shift Sets or by Name
get
Create Standard Shift Set
post
Create Standard Shift Sets
post
Delete Standard Shift Sets
post
Retrieve Standard Shift Sets
post
Update Standard Shift Sets
post
Delete Standard Shift Set by ID
delete
Retrieve Standard Shift Sets by ID
get
Update Standard Shift Set by ID
put
Swap Recommendations Settings Profiles
Retrieve All Swap Recommendations Settings Profiles or by Name
get
Create Swap Recommendations Settings Profile
post
Retrieve Swap Recommendations Settings Profiles
post
Delete Swap Recommendations Settings Profile
delete
Retrieve Swap Recommendations Settings Profile by ID
get
Update Swap Recommendations Settings Profile
put
Symbolic Source Types
Retrieve All Symbolic Source Types or by Name
get
Retrieve Symbolic Source Types
post
Retrieve Symbolic Source Type by ID
get
Tag Definitions
Retrieve Tag Definition by Name
get
Create Tag Definition
post
Retrieve Tag Definitions with Criterion
post
Delete Tag Definition by ID
delete
Retrieve Tag Definition by ID
get
Update (Replace) Tag Definition by ID
post
Update Tag Definition by ID
put
Team Definitions
Retrieve Team Definition by Name
get
Create Team Definition
post
Retrieve Team Definitions with Criterion
post
Delete Team Definition by ID
delete
Retrieve Team Definition By ID
get
Update Team Definition by ID
put
Visibility Period Actions
Retrieve All Visibility Period Actions or by Name
get
Create Visibility Period Action
post
Create Visibility Period Actions
post
Delete Visibility Period Actions
post
Retrieve Visibility Period Actions
post
Update Visibility Period Actions
post
Delete Visibility Period Action by ID
delete
Retrieve Visibility Period Action by ID
get
Update Visibility Period Action by ID
put
Worker Types
Retrieve All Worker Types
get
Workload Patterns
Bulk Delete Workload Patterns
post
Bulk Retrieve Workload Patterns
post
Bulk Create or Update Workload Patterns
post
Workload Planner Profiles
Retrieve All Workload Planner Profiles
get
Retrieve Workload Planner Profiles
post
Retrieve Workload Planner Profile by ID
get
Zone Categories
Retrieve All Zone Categories or by Name
get
Retrieve Zone Categories
post
Retrieve Zone Category by ID
get
Setup Zone Categories
Scheduling
Availabilities
Delete Availability by ID
delete
Retrieve Availability by ID
get
Create Availability
post
Delete Availabilities
delete
Create Availabilities by ID
post
Call Logs
Create Call Log
post
Create Call Logs
post
Retrieve Call Logs
post
Retrieve Call Log by ID
get
Day Locks
Lock Multiple Days
post
Unlock Multiple Days
post
Employee Schedule Patterns
Create Employee Schedule Pattern
post
Update Employee Schedule Patterns
post
Retrieve Builder Configuration
get
Retrieve Employee Schedule Patterns
post
Delete Employee Schedule Pattern by ID
delete
Retrieve Employee Schedule Pattern by ID
get
Employment Term Schedule Patterns
Create Employment Term Schedule Pattern
post
Update or Remove Employment Term Schedule Patterns
post
Retrieve Employment Term Schedule Pattern Configuration
get
Retrieve Employment Term Schedule Patterns
post
Delete Employment Term Schedule Pattern by ID
delete
Retrieve Employment Term Schedule Pattern by ID
get
Employment Terms Paycode Edits
Create Employment Terms PCEs
post
Delete Employment Terms PCEs
post
Update Employment Terms PCEs
post
Retrieve Employment Terms PCE by ID
get
Employment Terms Shifts
Create Employment Terms Shifts
post
Delete Employment Terms Shifts
post
Update Employment Terms Shifts
post
Retrieve Employment Terms Shift by ID
get
Employment Terms for Manager
Retrieve Employee Employment Terms Schedule
get
Retrieve Employee Employment Terms
post
Update Schedule Employment Terms
post
Retrieve Employment Terms Schedule Statuses
post
Group Assignments
Add Group Membership
post
Remove Group Membership
post
Group Paycode Edits
Create Group PCEs
post
Delete Group PCEs
post
Update Group PCEs
post
Retrieve Group PCE by ID
get
Group Schedule Patterns
Create Group Schedule Pattern
post
Update or Remove Group Schedule Patterns
post
Retrieve Group Schedule Pattern Configuration
get
Retrieve Multiple Group Schedule Patterns
post
Delete Group Schedule Pattern by ID
delete
Retrieve Group Schedule Pattern by ID
get
Group Schedules for Manager
Retrieve Employee Group Schedule
get
Retrieve Multiple Employee Group Schedules
post
Update Schedule Group
post
Retrieve Group Schedule Statuses
post
Group Shifts
Create Group Shifts
post
Delete Group Shifts
post
Update Group Shifts
post
Retrieve Group Shift by ID
get
Leave Edits for Scheduling
Create Leave Edit
post
Create Scheduling Leave Edits with Options
post
Delete Scheduling Leave Edits
post
Update Scheduling Leave Edit with Bypass for Accrual Warnings
post
Delete Leave Edit by ID
delete
Retrieve Scheduling Leave Edit by ID
get
Update Scheduling Leave Edit by ID
post
Manager Schedule Actions
Post or Unpost Schedule
post
Send Combined Schedule Notifications
post
Retrieve Posted Schedule with Criterion
post
Send Schedule Change Notifications
post
Manager Schedules
Retrieve Schedule with Criterion
get
Update Schedule
post
Retrieve Employee Schedule Changes
post
Retrieve Schedule
post
Update Schedule for Multiple Employees
post
Retrieve Employee Schedule Statuses
post
Metrics for Scheduling
Evaluate Metrics for Scheduling
post
Open Shifts
Retrieve Calculated Open Shifts
post
Paycode Edits for Scheduling
Create PCE
post
Create PCE with Options
post
Create Paycode Edits with Options
post
Update PCE with Bypass for Accrual Warnings
post
Create Paycode Edits with Options (Deprecated)
post
Create Paycode Edits
post
Delete Paycode Edits by ID
post
Update Paycode Edits
post
Delete PCE by ID
delete
Retrieve PCE by ID
get
Update PCE by ID
post
Procedure Set Engine
Retrieve Sorted or Eligible Employees
post
Rule Violations
Retrieve Employee Rule Violations
post
Evaluate Employee Rule Violations
post
Evaluate Employee Rule Violations and Save Schedule
post
Schedule Audits
Retrieve Schedule Audits
post
Schedule Generation Engine Strategies
Retrieve All Strategies or by Name
get
Create Strategy
post
Update Strategy Assignments to Locations
post
Retrieve Locations Assigned to Strategies
post
Create Strategies
post
Delete Strategies
post
Retrieve Strategies
post
Update Strategies
post
Retrieve All Parameter Definitions for Strategies or by Name
get
Retrieve Strategies Assigned to Location by ID
get
Retrieve Strategies Assigned to Locations
post
Delete Strategy by ID
delete
Retrieve Strategy by ID
get
Update Strategy by ID
put
Retrieve Locations Assigned to Strategy by ID
get
Schedule Generation Profiles
Delete Schedule Generation Profile by ID
delete
Create Schedule Generation Profile
post
Retrieve All Schedule Generation Profiles or by Name
get
Delete Schedule Generation Profiles
post
Update Schedule Generation Profile by ID
put
Retrieve Schedule Generation Profile by ID
get
Create Schedule Generation Profiles
post
Retrieve Schedule Generation Profiles
post
Update Schedule Generation Profiles
post
Schedule Generation Setup
Delete Schedule Generation Setup by ID
delete
Retrieve Schedule Generation Setup Parameter Values
get
Retrieve Schedule Generation Setup Assignments by Location
get
Create Schedule Generation Setup
post
Retrieve All Schedule Generation Setups or by Name
get
Retrieve Locations Assigned to Schedule Generation Setups
post
Retrieve Schedule Generation Setup Assignments for Multiple Locations
post
Delete Schedule Generation Setups
post
Retrieve Locations Assigned to Schedule Generation Setup by ID
get
Retrieve Schedule Generation Setups
post
Update Schedule Generation Setup by ID
put
Retrieve Schedule Generation Setup by ID
get
Retrieve All Schedule Generation Setup Parameters
get
Create Schedule Generation Setups
post
Update Schedule Generation Setups
post
Schedule Group Patterns
Create Schedule Group Pattern
post
Update or Remove Schedule Group Patterns
post
Retrieve Schedule Group Pattern Configuration
get
Retrieve Schedule Group Patterns
post
Delete Schedule Group Pattern by ID
delete
Retrieve Schedule Group Pattern by ID
get
Schedule Group Profiles
Retrieve All Schedule Group Profiles
get
Schedule Planner Profiles
Retrieve All Schedule Planner Profiles or by Name
get
Retrieve Schedule Planner Profiles
post
Retrieve Schedule Planner Profile by ID
get
Schedule Scores
Retrieve Schedule Scores
post
Schedule Tags
Create Schedule Tag
post
Create Schedule Tags
post
Delete Schedule Tags
post
Retrieve Schedule Tags by ID
post
Update Schedule Tags
post
Delete Schedule Tag by ID
delete
Retrieve Schedule Tag by ID
get
Update Schedule Tag by ID
post
Scheduling Engines
Retrieve Summary of Scheduling Engine Asynchronous Delegate Profile Jobs
get
Execute Scheduling Engine Asynchronously
post
Retrieve Scheduling Engine Asynchronous Response Payload by Key
get
Retrieve Scheduling Engine Asynchronous Request Status by Key
get
Shift Profile Sets
Retrieve All Shift Profile Sets or by Name
get
Create Shift Profile Set
post
Create Shift Profile Sets
post
Delete Shift Profile Sets
post
Retrieve Shift Profile Sets
post
Update Shift Profile Sets
post
Delete Shift Profile Set by ID
delete
Retrieve Shift Profile Set by ID
get
Update Shift Profile Set by ID
put
Shift Profiles
Retrieve All Shift Profiles or by Name
get
Create Shift Profile
post
Create Shift Profiles
post
Delete Shift Profiles
post
Retrieve Shift Profiles
post
Update Shift Profiles
post
Delete Shift Profile by ID
delete
Retrieve Shift Profile by ID
get
Update Shift Profile by ID
put
Shifts
Create Shift
post
Create Shifts from Patterns
post
Update Shifts with Criteria
post
Create Shifts
post
Delete Shifts
post
Retrieve Shifts
post
Update Shifts
post
Delete Shift by ID
delete
Retrieve Shift by ID
get
Update Shift by ID
post
Skill and Certificate Profiles
Retrieve All Skill and Certification Profiles or by Name
get
Create Skill and Certification Profile
post
Create Skill and Certification Profiles
post
Delete Skill and Certification Profiles
post
Retrieve Skill and Certification Profiles
post
Update Skill and Certification Profiles
post
Retrieve Skill and Certification Profile by ID
get
Update Skill and Certification Profile
put
Delete Skill and Certification Profile by ID
delete
Swap Recommendation Messages
Retrieve Swap Recommendation Message by Name
get
Retrieve Swap Recommendation Messages
post
Retrieve Swap Recommendation Message by ID
get
Workload Coverage
Evaluate Coverage
post
Evaluate Coverage Details
post
Evaluate Coverage Spans
post
Evaluate Workload
post
Evaluate Workload Coverage Details
post
Evaluate Workload Details
post
Workload Generator
Generate a Workload
post
Workload Overrides
Delete Workload Overrides
post
Retrieve Workload Overrides
post
Create or Update Workload Overrides
post
Workload Volume
Update Workload Weights or Update, Lock, or Unlock Workload Volumes
post
Retrieve Workload Volumes
post
Timekeeping Bulk Operations
Bulk Asynchronous Paycode Edits
Retrieve Summary of Asynchronous Paycode Edit Import Jobs
get
Bulk Import Paycode Edits Asynchronously
post
Retrieve Asynchronous Paycode Edit Import Response Payload by Key
get
Retrieve Paycode Edit Import Asynchronous Request Status by Key
get
Bulk Enable Edits
Enable Edits Bulk Update
post
Bulk Paycode Edits
Bulk Import Paycode Edits
post
Bulk Delete Paycode Edits
post
Bulk Payroll Lock
Lock Payroll in Bulk
post
Bulk Punches
Bulk Import Punches
post
Bulk Punches and Paycode Edits
Bulk Import Punches and Paycode Edits
post
Bulk Real Time Punches
Retrieve Punches in Real Time
post
Bulk Timecard Approvals
Approve Timecards in Bulk
post
Bulk Timecard Delete Approvals
post
Bulk Timecard Signoffs
Bulk Timecard Signoffs
post
Timekeeping Setup
Accrual Codes
Retrieve Accrual Codes (Deprecated)
get
Retrieve Accrual Code by ID
get
Retrieve Accrual Codes
get
Accrual Policies
Retrieve Accrual Policies
post
Retrieve Accrual Policy by ID
get
Accrual Profiles
Retrieve All Accrual Profiles (Deprecated)
get
Retrieve Accrual Profiles
post
Retrieve Accrual Profile by ID (Deprecated)
get
Retrieve All Accrual Profiles
get
Retrieve Accrual Profile by ID
get
Adjustment Rules
Retrieve All Adjustment Rules
get
Create Adjustment Rule
post
Retrieve Adjustment Rules
post
Create or Update Adjustment Rule Versions
post
Delete Adjustment Rule by ID
delete
Create and Assign Adjustment Rule Version by ID
post
Update Adjustment Rule by ID
put
Bonus and Deduction Rules
Retrieve Bonus and Deduction Rules (Deprecated)
get
Retrieve Bonus or Deduction Rule by ID (Deprecated)
get
Retrieve Bonus and Deduction Rules
get
Retrieve Bonus or Deduction Rule by ID
get
Break Rules
Retrieve All Break Rules
get
Retrieve Break Rule by ID
get
Retrieve GDAP-filtered Break Rules
get
Retrieve GDAP-filtered Break Rule by ID
get
Combination Rules
Retrieve All Combination Rules
get
Create Combination Rule
post
Create or Update Combination Rules
post
Create Combination Rules
post
Delete Combination Rules
post
Retrieve Combination Rules
post
Update Combination Rules
post
Delete Combination Rule by ID
delete
Retrieve Combination Rule by ID
get
Update Combination Rule by ID
put
Combined Paycodes for Timekeeping
Retrieve Combined Paycodes
post
Add Paycodes to or Remove Paycodes from Combined Paycodes
post
Retrieve Combined Paycode by ID
get
Employment Terms
Retrieve Employment Term (Deprecated)
get
Create Employment Term
post
Retrieve Employment Terms
post
Update Employment Term Versions
post
Delete Employment Term by ID
delete
Retrieve Employment Term by ID (Deprecated)
get
Update Employment Term by ID
put
Retrieve All Employment Terms
get
Retrieve Employment Term by ID
get
Pay Code Tags
Retrieve All Pay Code Tags
get
Create Pay Code Tag
post
Delete Pay Code Tag by ID
delete
Retrieve Pay Code Tag by ID
get
Update Pay Code Tag by ID
put
Paycode Distributions
Retrieve All Paycode Distributions or by Name
get
Create Paycode Distribution
post
Create or Update Paycode Distributions
post
Create Paycode Distributions
post
Delete Paycode Distributions
post
Retrieve Paycode Distributions
post
Update Paycode Distributions
post
Delete Paycode Distribution by ID
delete
Retrieve Paycode Distribution by ID
get
Update Paycode Distribution by ID
put
Paycodes for Timekeeping
Retrieve Paycode Symbolic Values as Employee (Deprecated)
get
Retrieve Paycode Symbolic Values by ID as Employee (Deprecated)
get
Retrieve Paycodes as Employee (Deprecated)
get
Retrieve Paycode by ID as Employee (Deprecated)
get
Retrieve Paycode Symbolic Values as Manager (Deprecated)
get
Retrieve Paycode Symbolic Value as Manager (Deprecated)
get
Retrieve Paycodes as Manager (Deprecated)
get
Create Paycode
post
Create Paycodes
post
Delete Paycodes
post
Retrieve Paycodes
post
Update Paycodes
post
Create or Update Paycodes
post
Delete Paycode by ID
delete
Retrieve Paycode by ID as Manager
get
Update Paycode by ID
put
Retrieve Full Paycodes as Manager
get
Retrieve Full Paycode by ID as Manager
get
Retrieve Paycode Symbolic Values as Employee
get
Retrieve Paycode Symbolic Value by ID as Employee
get
Retrieve Paycodes as Employee
get
Retrieve Paycode by ID as Employee
get
Retrieve Paycode Symbolic Values as Manager
get
Retrieve Paycode Symbolic Value by ID as Manager
get
Retrieve Paycodes as Manager
get
Percentage Allocation Rules
Retrieve All Percentage Allocation Rules
get
Create Percentage Allocation Rule
post
Retrieve Percentage Allocation Rules
post
Delete Percentage Allocation Rule by ID
delete
Add Rule Version to Percentage Allocation Rule by ID
post
Update Percentage Allocation Rule by ID
put
Prevailing Wages
Retrieve Prevailing Wages
get
Create or Update Prevailing Wages
post
Punch Interpretation Rules
Delete Punch Interpretation Rule by ID
delete
Retrieve All Punch Interpretation Rules
get
Delete Punch Interpretation Rules
post
Add or Update Punch Interpretation Rules
post
Time-Off Rules
Retrieve All Time-Off Rules
get
Timecard Add-On Group Options
Retrieve Timecard Add-On Group Options
get
Timekeeping Fixed Rules
Retrieve All Fixed Rules
get
Create Fixed Rule
post
Create Fixed Rules
post
Delete Fixed Rules
post
Retrieve Fixed Rules
post
Update Fixed Rules
post
Create or Update Fixed Rules
post
Delete Fixed Rule by ID
delete
Retrieve Fixed Rule by ID
get
Update Fixed Rule by ID
put
Timekeeping Holidays
Retrieve All Holidays
get
Add or Update Holidays
post
Add or Remove Holidays
post
Timekeeping Overtime Rules
Retrieve All Overtime Rules
get
Create Overtime Rule
post
Create Overtime Rules
post
Delete Overtime Rules
post
Retrieve Overtime Rules
post
Update Overtime Rules
post
Delete Overtime Rule by ID
delete
Retrieve Overtime Rule by ID
get
Update Overtime Rule by ID
put
Timekeeping Pay Rules
Retrieve All Timekeeping Pay Rules (Deprecated)
get
Create Timekeeping Pay Rule (Deprecated)
post
Create Timekeeping Pay Rules
post
Delete Timekeeping Pay Rules
post
Retrieve Timekeeping Pay Rules
post
Update Timekeeping Pay Rules
post
Delete Timekeeping Pay Rule by ID
delete
Update Timekeeping Pay Rule by ID
put
Retrieve All Timekeeping Pay Rules
get
Create Timekeeping Pay Rule
post
Work Rules
Retrieve Work Rules as Employee (Deprecated)
get
Retrieve Work Rule by ID as Employee (Deprecated)
get
Retrieve All Work Rules
get
Create Work Rule
post
Create Work Rules
post
Delete Work Rules
post
Retrieve Work Rules
post
Update Work Rules
post
Delete Work Rule by ID
delete
Retrieve Work Rule by ID
get
Update Work Rule by ID
put
Retrieve Work Rules as Manager (Deprecated)
get
Retrieve Work Rule by ID as Manager (Deprecated)
get
Retrieve Work Rules as Employee
get
Retrieve Work Rule by ID as Employee
get
Retrieve Work Rules as Manager
get
Retrieve Work Rule by ID as Manager
get
Holidays
Timekeeping Timecards
Timecard Add-On Columns
Retrieve Timecard Add-On Columns
get
Timecard Add-On Profiles
Retrieve All Timecard Add-On Profiles
get
Create Timecard Add-On Profile
post
Delete Timecard Add-On Profile by ID
delete
Retrieve Timecard Add-On Profile by ID
get
Update Timecard Add-On Profile by ID
put
Timecard Add-On Types
Retrieve Timecard Add-On Types
get
Timecard Approvals for Employee
Remove Timecard Approvals as Employee
delete
Retrieve Timecard Approvals as Employee
get
Approve Timecard as Employee
post
Timecard Approvals for Manager
Remove Timecard Approvals as Manager
delete
Retrieve Timecard Approvals as Manager
get
Approve Timecard as Manager
post
Timecard Changes
Retrieve Timecard Changes
get
Update Timecard Change Statuses
post
Retrieve Timecard Change by ID
get
Update Timecard Change Status
put
Timecard Changes for Reports
Retrieve Timecard Changes for Reports
post
Timecard Metrics
Retrieve Timecard Data for Multiple Employees
post
Timecard Settings
Retrieve All Timecard Settings
get
Create Timecard Setting
post
Retrieve Timecard Settings
post
Delete Timecard Setting by ID
delete
Retrieve Timecard Setting by ID
get
Update Timecard Setting by ID
put
Timecards
Retrieve Timecard as Employee
get
Update Timecard as Employee
post
Retrieve Timecards as Employee
post
Retrieve Timecard as Manager
get
Update Timecard as Manager
post
Retrieve Timecards as Manager
post
Timekeeping
Absence Spans
Retrieve Absence Spans
post
Accrual Move Balances
Move Accrual Balances for Multiple Employees
post
Accruals Bulk Transactions
Bulk Accrual Payout
post
Bulk Accrual Reset
post
Bulk Accrual Suspensions or Reinstatements
post
Accruals Bulk Update
Apply Updates to Accrual Balances for Multiple Employees
post
Accruals from Paycodes
Retrieve Accrual Codes from Paycodes
post
Aggregated Transfer Data
Return Aggregated Transfer Data
post
Attestation Answers
Retrieve All Attestation Answers or by Name
get
Create Attestation Answer
post
Create Attestation Answers
post
Delete Attestation Answers
post
Retrieve Attestation Answers
post
Update Attestation Answers
post
Retrieve Action Types for Attestation Answers
get
Delete Attestation Answer by ID
delete
Retrieve Attestation Answer by ID
get
Update Attestation Answer by ID
put
Attestation Assignments
Retrieve All Attestation Assignments
get
Create Attestation Assignment
post
Delete Attestation Assignment by ID
delete
Retrieve Attestation Assignment by ID
get
Update Attestation Assignment by ID
put
Attestation Buttons
Retrieve All Attestation Buttons
get
Create Attestation Button
post
Delete Attestation Button by ID
delete
Retrieve Attestation Button by ID
get
Update Attestation Button by ID
put
Attestation Conditions
Retrieve All Attestation Conditions
get
Create Attestation Condition
post
Delete Attestation Condition by ID
delete
Retrieve Attestation Condition by ID
get
Update Attestation Condition by ID
put
Attestation Daily Details
Retrieve Attestation Daily Details
post
Attestation Display and Submit Forms
Create Attestation Display Form
post
Create Attestation Submit Form
post
Attestation Models
Retrieve All Attestation Models
get
Attestation Profile Buttons
Retrieve Attestation Profile Buttons
get
Attestation Profiles
Retrieve All Attestation Profiles
get
Create Attestation Profile
post
Delete Attestation Profile by ID
delete
Retrieve Attestation Profile by ID
get
Update Attestation Profile by ID
put
Attestation Questions
Retrieve All Attestation Questions or by Name
get
Create Attestation Question
post
Create Attestation Questions
post
Delete Attestation Questions
post
Retrieve Attestation Questions
post
Update Attestation Questions
post
Retrieve Attestation Question Display Types
get
Delete Attestation Question by ID
delete
Retrieve Attestation Question by ID
get
Update Attestation Question by ID
put
Attestation Template Mappings
Retrieve All Attestation Template Mappings
get
Create Attestation Template Mapping
post
Delete Attestation Template Mappings
post
Retrieve Attestation Template Mappings
post
Delete Attestation Template Mapping by ID
delete
Retrieve Attestation Template Mapping by ID
get
Update Attestation Template Mapping by ID
put
Attestation Unapproved Timecard Data
Retrieve Unapproved Timecard Data
get
Attestation Workflow Attributes
Set Attestation Workflow Attributes by ID
post
Attestation Workflows
Retrieve Attestation Workflow by Name
get
Retrieve Attestation Workflows by Name
get
Brazil Compliance Companies
Retrieve All Brazil Compliance Companies
get
Create Brazil Compliance Company
post
Delete Brazil Compliance Company by ID
delete
Retrieve Brazil Compliance Company by ID
get
Update Brazil Compliance Company by ID
put
Brazil Compliance Device Groups
Retrieve All Brazil Compliance Device Groups or by Specification
get
Create Brazil Compliance Device Group
post
Delete Brazil Compliance Device Group by ID
delete
Retrieve Brazil Compliance Device Group by ID
get
Update Brazil Compliance Device Group by ID
put
Brazil Compliance Devices
Retrieve All Brazil Compliance Devices or by Specification
get
Create Brazil Compliance Device
post
Delete Brazil Compliance Device by ID
delete
Retrieve Brazil Compliance Device by ID
get
Update Brazil Compliance Device by ID
put
Brazil Compliance Digital Signature
Sign Brazil Compliance Reports
post
Brazil Compliance Identity Types
Retrieve All Brazil Compliance Identity Types or by Specification
get
Retrieve Brazil Compliance Identity Type by ID
get
Brazil Compliance Paycode Attributes
Retrieve All Brazil Compliance Paycode Attribute Definition Keys or by Specification
get
Retrieve Brazil Compliance Paycode Attribute Definition Key by ID
get
Retrieve All Brazil Compliance Paycode Attribute Definitions or by Specification
get
Create Brazil Compliance Paycode Attribute Definition
post
Delete Brazil Compliance Paycode Attribute Definition by ID
delete
Retrieve Brazil Compliance Paycode Attribute Definition by ID
get
Update Brazil Compliance Paycode Attribute Definition by ID
put
Brazil Compliance System Settings
Retrieve Brazil Compliance System Settings
get
Complete Attestation Process
Complete an Attestation Process
post
Complete Manual Time Entry Attestation Process
Complete a Manual Time Entry Attestation Process
post
Exception Categories
Retrieve All Exception Categories
get
Create Exception Category
post
Create Exception Categories
post
Delete Exception Categories
post
Retrieve Exception Categories
post
Update Exception Categories
post
Delete Exception Category by ID
delete
Retrieve Exception Category by ID
get
Update Exception Category by ID
put
Retrieve All Exception Types
get
Exception Tiles
Retrieve All Exception Tiles
get
Create Exception Tile
post
Create Exception Tiles
post
Delete Exception Tiles
post
Update Exception Tiles
post
Delete Exception Tile by ID
delete
Retrieve Exception Tile by ID
get
Update Exception Tile by ID
put
Manual Time Entry Workflows
Retrieve Manual Time Entry Workflows
post
Paycode Data Access Profiles
Retrieve All Paycode Data Access Profiles
get
Create Paycode Data Access Profiles
post
Retrieve Paycode Data Access Profiles by Paycodes
post
Add Paycodes to or Remove Paycodes from Paycode Data Access Profiles
post
Delete Paycode Data Access Profiles
post
Retrieve Paycode Data Access Profiles
post
Create or Update Paycode Data Access Profiles
post
Delete Paycode Data Access Profile by ID
delete
Retrieve Paycode Data Access Profile by ID
get
Update Paycode Data Access Profile by ID
put
Retrieve GDAP-filtered Paycode Data Access Profile by ID
get
Pending Historical Corrections
Retrieve Summary of Asynchronous Pending Historical Compute Corrections Jobs
get
Compute Pending Historical Corrections
post
Retrieve Asynchronous Computed Pending Historical Corrections by Key
get
Retrieve Compute Pending Historical Corrections Asynchronous Request Status by Key
get
Retrieve Summary of Asynchronous Save Pending Historical Corrections Jobs
get
Save Pending Historical Corrections
post
Retrieve Asynchronous Saved Pending Historical Corrections by Key
get
Retrieve Save Pending Historical Corrections Asynchronous Request Status by Key
get
Sign-off Preparation
Disable Sign-off Preparation by ID
delete
Retrieve Sign-off Preparation Status by ID
get
Enable Sign-off Preparation by ID
post
Bulk Disable Sign-off Preparation
post
Bulk Retrieve Sign-off Preparation Status
post
Bulk Enable Sign-off Preparation
post
Signoffs for Employee
Delete Employee Timecard Signoff as Employee
delete
Retrieve Signoffs as Employee
get
Sign Off Employee Timecard as Employee
post
Signoffs for Manager
Retrieve Automatic Signoff Status
get
Delete Employee Timecard Signoff as Manager
delete
Retrieve Signoffs as Manager
get
Sign Off Employee Timecard as Manager
post
Start Attestation Process
Start an Attestation Process
post
Start Offline Attestation Process
Start an Offline Attestation Process
post
Timecard Annotations
Delete Timecard Annotation
delete
Retrieve Timecard Annotation
get
Create Timecard Annotation
post
Timekeeping Alert Profiles
Retrieve All Timekeeping Alert Profiles
get
Retrieve Timekeeping Alert Profiles
post
Retrieve Timekeeping Alert Profile by ID
get
Timestamps
Retrieve MRU Transfers
get
Retrieve Timestamp
get
Add Timestamp
post
Work Rule Data Access Profiles
Retrieve Available Work Rule Data Access Profile by ID
get
Retrieve Work Rule Data Access Profile by ID
get
Retrieve Work Rule Data Access Profiles
post
Retrieve All Work Rule Data Access Profiles
get
Universal Device Manager
UDM Device Groups
Delete Device Group by ID
delete
Update Device Group by ID
put
Retrieve All Device Groups
get
Create Device Group
post
UDM Device Statuses
Retrieve All Device Statuses
get
Retrieve a Device Status
get
UDM Devices
Retrieve All Devices
get
Create Customer
post
https://{hostname}/api/v1/work/customers
This operation creates a Customer.
Language
Shell
Node
Ruby
PHP
Python
URL
Base URL
https://
hostname
/api
/v1/work/customers
