How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys Workforce Management API

Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration

Genesys Workforce Management API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workforce Management. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 324 operations across 250 paths, and defines 773 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

324 operations 250 paths 773 schemas 21 DELETE137 GET38 PATCH124 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Workforce Management API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 324

Across 250 paths, the API surfaces 324 operations — 21 DELETE, 137 GET, 38 PATCH, 124 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Workforce Management 324

Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration

GET
/api/v2/workforcemanagement/calendar/data/ics
Get ics formatted calendar based on shareable link
getWorkforcemanagementCalendarDataIcs 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodesdeprecated
Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
getWorkforcemanagementManagementunitActivitycodes 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes
Get activity codes
getWorkforcemanagementBusinessunitActivitycodes 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes
Create a new activity code
postWorkforcemanagementBusinessunitActivitycodes 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Get an activity code
getWorkforcemanagementBusinessunitActivitycode 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Deletes an activity code
deleteWorkforcemanagementBusinessunitActivitycode 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Update an activity code
patchWorkforcemanagementBusinessunitActivitycode 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups
Get intraday planning groups for the given date
getWorkforcemanagementBusinessunitIntradayPlanninggroups 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday
Get intraday data for the given date for the requested planningGroupIds
postWorkforcemanagementBusinessunitIntraday 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl
Creates a signed upload URL for importing a short term forecast
postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl 3 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import
Starts importing the uploaded short term forecast
postWorkforcemanagementBusinessunitWeekShorttermforecastsImport 3 params → 200202400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults
Gets the forecast generation results
getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts
Get short term forecasts
getWorkforcemanagementBusinessunitWeekShorttermforecasts 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate
Generate a short term forecast
postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate 4 params → 200202201400401403404408
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}
Get a short term forecast
getWorkforcemanagementBusinessunitWeekShorttermforecast 4 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}
Delete a short term forecast
deleteWorkforcemanagementBusinessunitWeekShorttermforecast 3 params → 204400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups
Gets the forecast planning group snapshot
getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data
Get the result of a short term forecast calculation
getWorkforcemanagementBusinessunitWeekShorttermforecastData 5 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement
Get the staffing requirement by planning group for a forecast
getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement 5 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata
Get the result of a long term forecast calculation
getWorkforcemanagementBusinessunitWeekShorttermforecastLongtermforecastdata 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy
Copy a short term forecast
postWorkforcemanagementBusinessunitWeekShorttermforecastCopy 5 params → 200202201400401403404408
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/users
Get users in the business unit
getWorkforcemanagementBusinessunitUsers 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}
Get business unit
getWorkforcemanagementBusinessunit 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}
Delete business unit
deleteWorkforcemanagementBusinessunit 1 param → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}
Update business unit
patchWorkforcemanagementBusinessunit 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits
Get all authorized management units in the business unit
getWorkforcemanagementBusinessunitManagementunits 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits
Get business units
getWorkforcemanagementBusinessunits 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits
Add a new business unit
postWorkforcemanagementBusinessunits 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/divisionviews
Get business units across divisions
getWorkforcemanagementBusinessunitsDivisionviews 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}
Get management unit
getWorkforcemanagementManagementunit 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}
Delete management unit
deleteWorkforcemanagementManagementunit 1 param → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}
Update the requested management unit
patchWorkforcemanagementManagementunit 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/move
Move the requested management unit to a new business unit
postWorkforcemanagementManagementunitMove 2 params → 200202400401403404408409
GET
/api/v2/workforcemanagement/managementunits
Get management units
getWorkforcemanagementManagementunits 5 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits
Add a management unit
postWorkforcemanagementManagementunits 1 param → 200201400401403404408409
GET
/api/v2/workforcemanagement/managementunits/divisionviews
Get management units across divisions
getWorkforcemanagementManagementunitsDivisionviews 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}
Get data for agent in the management unit
getWorkforcemanagementManagementunitAgent 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttradesdeprecated
Gets all the shift trades for a given agent
getWorkforcemanagementManagementunitAgentShifttrades 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents
Update agent configurations
patchWorkforcemanagementManagementunitAgents 2 params → 204400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query
Get agents work plans configuration
postWorkforcemanagementManagementunitAgentsWorkplansQuery 3 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk
Updates agent work plan configuration
patchWorkforcemanagementManagementunitAgentsWorkplansBulk 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users
Get users in the management unit
getWorkforcemanagementManagementunitUsers 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Get a planning group
getWorkforcemanagementBusinessunitPlanninggroup 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Deletes the planning group
deleteWorkforcemanagementBusinessunitPlanninggroup 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Updates the planning group
patchWorkforcemanagementBusinessunitPlanninggroup 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups
Gets list of planning groups
getWorkforcemanagementBusinessunitPlanninggroups 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups
Adds a new planning group
postWorkforcemanagementBusinessunitPlanninggroups 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Get a service goal template
getWorkforcemanagementBusinessunitServicegoaltemplate 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Delete a service goal template
deleteWorkforcemanagementBusinessunitServicegoaltemplate 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Updates a service goal template
patchWorkforcemanagementBusinessunitServicegoaltemplate 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates
Gets list of service goal templates
getWorkforcemanagementBusinessunitServicegoaltemplates 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates
Adds a new service goal template
postWorkforcemanagementBusinessunitServicegoaltemplates 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users
Gets list of users available for whom you can send direct shift trade requests
getWorkforcemanagementManagementunitShifttradesUsers 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matcheddeprecated
Gets a summary of all shift trades in the matched state
getWorkforcemanagementManagementunitShifttradesMatched 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups
Gets a list of staffing groups
getWorkforcemanagementBusinessunitStaffinggroups 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups
Creates a new staffing group
postWorkforcemanagementBusinessunitStaffinggroups 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Gets a staffing group
getWorkforcemanagementBusinessunitStaffinggroup 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Deletes a staffing group
deleteWorkforcemanagementBusinessunitStaffinggroup 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Updates a staffing group
patchWorkforcemanagementBusinessunitStaffinggroup 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query
Gets a list of planning group to staffing groups list association
postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query
Gets staffing group associations for a list of user IDs
postWorkforcemanagementBusinessunitStaffinggroupsQuery 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/searchdeprecated
Searches for potential shift trade matches for the current agent
postWorkforcemanagementManagementunitWeekShifttradesSearch 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttradesdeprecated
Gets all the shift trades for a given week
getWorkforcemanagementManagementunitWeekShifttrades 5 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttradesdeprecated
Adds a shift trade
postWorkforcemanagementManagementunitWeekShifttrades 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulkdeprecated
Updates the state of a batch of shift trades
postWorkforcemanagementManagementunitWeekShifttradesStateBulk 4 params → 200202400401403404408409
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}deprecated
Updates a shift trade. This route can only be called by the initiating agent
patchWorkforcemanagementManagementunitWeekShifttrade 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/matchdeprecated
Matches a shift trade. This route can only be called by the receiving agent
postWorkforcemanagementManagementunitWeekShifttradeMatch 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents
Move agents in and out of management unit
postWorkforcemanagementAgents 1 param → 202400401403404408409413
GET
/api/v2/workforcemanagement/agents/{agentId}/managementunit
Get the management unit to which the agent belongs
getWorkforcemanagementAgentManagementunit 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/agents/me/managementunit
Get the management unit to which the currently logged in agent belongs
getWorkforcemanagementAgentsMeManagementunit → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate
Validate Work Plan
postWorkforcemanagementManagementunitWorkplanValidate 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Get a work plan
getWorkforcemanagementManagementunitWorkplan 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Delete a work plan
deleteWorkforcemanagementManagementunitWorkplan 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Update a work plan
patchWorkforcemanagementManagementunitWorkplan 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans
Get work plans
getWorkforcemanagementManagementunitWorkplans 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans
Create a new work plan
postWorkforcemanagementManagementunitWorkplans 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy
Create a copy of work plan
postWorkforcemanagementManagementunitWorkplanCopy 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations
Get work plan rotations
getWorkforcemanagementManagementunitWorkplanrotations 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations
Create a new work plan rotation
postWorkforcemanagementManagementunitWorkplanrotations 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Get a work plan rotation
getWorkforcemanagementManagementunitWorkplanrotation 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Delete a work plan rotation
deleteWorkforcemanagementManagementunitWorkplanrotation 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Update a work plan rotation
patchWorkforcemanagementManagementunitWorkplanrotation 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy
Create a copy of work plan rotation
postWorkforcemanagementManagementunitWorkplanrotationCopy 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs
Gets the latest job for all activity plans in the business unit
getWorkforcemanagementBusinessunitActivityplansJobs 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans
Get activity plans
getWorkforcemanagementBusinessunitActivityplans 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans
Create an activity plan
postWorkforcemanagementBusinessunitActivityplans 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}
Get an activity plan
getWorkforcemanagementBusinessunitActivityplan 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}
Update an activity plan
patchWorkforcemanagementBusinessunitActivityplan 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs
Run an activity plan manually
postWorkforcemanagementBusinessunitActivityplanRunsJobs 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}
Gets an activity plan run job
getWorkforcemanagementBusinessunitActivityplanRunsJob 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}
Query the status of an adherence explanation operation. Only the user who started the operation can query the status
getWorkforcemanagementAdherenceExplanationsJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations
Add an adherence explanation for the requested user
postWorkforcemanagementAgentAdherenceExplanations 2 params → 202400401403404408409413
GET
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}
Get an adherence explanation
getWorkforcemanagementAgentAdherenceExplanation 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}
Update an adherence explanation
patchWorkforcemanagementAgentAdherenceExplanation 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query
Query adherence explanations for the given agent across a specified range
postWorkforcemanagementAgentAdherenceExplanationsQuery 4 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query
Query adherence explanations across an entire business unit for the requested period
postWorkforcemanagementBusinessunitAdherenceExplanationsQuery 4 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/adherence/explanations
Submit an adherence explanation for the current user
postWorkforcemanagementAdherenceExplanations 1 param → 202400401403404408409413
GET
/api/v2/workforcemanagement/adherence/explanations/{explanationId}
Get an adherence explanation for the current user
getWorkforcemanagementAdherenceExplanation 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/adherence/explanations/query
Query adherence explanations for the current user
postWorkforcemanagementAdherenceExplanationsQuery 3 params → 202400401403404408409413
GET
/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}
Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status
getWorkforcemanagementAgentsMeAdherenceHistoricalJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/me/adherence/historical/jobs
Request an agent historical adherence report
postWorkforcemanagementAgentsMeAdherenceHistoricalJobs 2 params → 202400401403404408409413
POST
/api/v2/workforcemanagement/adherence/historical/bulk
Request a historical adherence report in bulk
postWorkforcemanagementAdherenceHistoricalBulk 1 param → 202400401403404408409413
GET
/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}
Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status
getWorkforcemanagementAdherenceHistoricalBulkJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}
Query the status of a historical adherence request operation. Only the user who started the operation can query the status
getWorkforcemanagementAdherenceHistoricalJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery
Request a historical adherence report
postWorkforcemanagementManagementunitHistoricaladherencequery 2 params → 202400401403404408409413
POST
/api/v2/workforcemanagement/teams/{teamId}/adherence/historical
Request a teams historical adherence report
postWorkforcemanagementTeamAdherenceHistorical 2 params → 202400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence
Get a list of user schedule adherence records for the requested management unit
getWorkforcemanagementManagementunitAdherence 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/teams/{teamId}/adherence
Get a list of user schedule adherence records for the requested team
getWorkforcemanagementTeamAdherence 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/adherence
Get a list of UserScheduleAdherence records for the requested users
getWorkforcemanagementAdherence 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/me/possibleworkshifts
Get agent possible work shifts for requested time frame
postWorkforcemanagementAgentsMePossibleworkshifts 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/settings/query
Query availability management units settings
postWorkforcemanagementBusinessunitUnavailabletimesSettingsQuery 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/schedules/query
Get agent schedule generation unavailable times
postWorkforcemanagementBusinessunitUnavailabletimesSchedulesQuery 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/unavailabletimes/settings
Update management unit availability settings
patchWorkforcemanagementManagementunitUnavailabletimesSettings 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/{agentId}/unavailabletimes/query
Get agent unavailable times
postWorkforcemanagementAgentUnavailabletimesQuery 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings
Get alternative shifts settings for a business unit
getWorkforcemanagementBusinessunitAlternativeshiftsSettings 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings
Update alternative shifts settings for a business unit
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search
List alternative shifts trades for a given management unit or agent
postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch 3 params → 200202400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}
Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}
Get an alternative shifts trade in a business unit for a given trade ID
getWorkforcemanagementBusinessunitAlternativeshiftsTrade 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/alternativeshifts/offers/jobs
Request a list of alternative shift offers for a given schedule
postWorkforcemanagementAlternativeshiftsOffersJobs 1 param → 200202400401403404408409
GET
/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}
Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
getWorkforcemanagementAlternativeshiftsOffersJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs
Request a search of alternative shift offers for a given shift
postWorkforcemanagementAlternativeshiftsOffersSearchJobs 1 param → 200202400401403404408409
GET
/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}
Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
getWorkforcemanagementAlternativeshiftsOffersSearchJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/alternativeshifts/trades
Get a list of my alternative shifts trades
getWorkforcemanagementAlternativeshiftsTrades 1 param → 200202400401403404408409
POST
/api/v2/workforcemanagement/alternativeshifts/trades
Create my alternative shift trade using an existing offer's jobId
postWorkforcemanagementAlternativeshiftsTrades 1 param → 200201400401403404408409
GET
/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}
Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
getWorkforcemanagementAlternativeshiftsTradesJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}
Get my alternative shift trade by trade ID
getWorkforcemanagementAlternativeshiftsTrade 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}
Update my alternative shifts trade by trade ID
patchWorkforcemanagementAlternativeshiftsTrade 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs
Bulk update alternative shift trade states
patchWorkforcemanagementAlternativeshiftsTradesStateJobs 1 param → 200202400401403404408409
GET
/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}
Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
getWorkforcemanagementAlternativeshiftsTradesStateJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/calendar/url/ics
Get existing calendar link for the current user
getWorkforcemanagementCalendarUrlIcs → 200400401403404408409413
POST
/api/v2/workforcemanagement/calendar/url/ics
Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned
postWorkforcemanagementCalendarUrlIcs 1 param → 200201400401403404408409
DELETE
/api/v2/workforcemanagement/calendar/url/ics
Disable generated calendar link for the current user
deleteWorkforcemanagementCalendarUrlIcs → 204400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}
Get a capacity plan
getWorkforcemanagementBusinessunitCapacityplan 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}
Update a capacity plan configuration
patchWorkforcemanagementBusinessunitCapacityplan 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans
Get list of capacity plans for a business unit
getWorkforcemanagementBusinessunitCapacityplans 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans
Create a new capacity plan
postWorkforcemanagementBusinessunitCapacityplans 2 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove
Delete capacity plans in a business unit
postWorkforcemanagementBusinessunitCapacityplansBulkRemove 2 params → 204400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations
Get a capacity plan's staffing group allocations
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations
Create staffing group allocations for a capacity plan
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations 3 params → 201400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements
Get a capacity plan's staffing requirements
getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy
Copy a capacity plan
postWorkforcemanagementBusinessunitCapacityplanCopy 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate
Regenerate requirements for capacity plan
postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query
Query staffing groups allocations history for a capacity plan
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory
Delete staffing group allocations history created for a capacity plan before the given date
deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory 3 params → 204400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast
Get a capacity plan's forecast inputs
getWorkforcemanagementBusinessunitCapacityplanForecast 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}
Get the latest long term staffing requirements for a business unit
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate
Force regenerate the latest long term staffing requirements for a business unit
postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/schedulebids
Gets the list of schedule bids that belong to an agent. It will fetch an open bid or upcoming bid or a bid that is closed recently
getWorkforcemanagementSchedulebids → 200400401403404408409413
GET
/api/v2/workforcemanagement/schedulebids/{bidId}/preference
Gets an agent's schedule bidding preference
getWorkforcemanagementSchedulebidPreference 1 param → 200400401403404408409413
PUT
/api/v2/workforcemanagement/schedulebids/{bidId}/preference
Update an agent's schedule set preference
putWorkforcemanagementSchedulebidPreference 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets
Gets an agent's schedule sets for a bid
getWorkforcemanagementSchedulebidSchedulesets 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/timeofflimits/available/query
Queries available time off for the current user
postWorkforcemanagementTimeofflimitsAvailableQuery 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions
Get the daily waitlist positions of a time off request for the current user
getWorkforcemanagementTimeoffrequestWaitlistpositions 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/timeoffrequests
Get a list of time off requests for the current user
getWorkforcemanagementTimeoffrequests → 200400401403404408409413
POST
/api/v2/workforcemanagement/timeoffrequests
Create a time off request for the current user
postWorkforcemanagementTimeoffrequests 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
Get a time off request for the current user
getWorkforcemanagementTimeoffrequest 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
Update a time off request for the current user
patchWorkforcemanagementTimeoffrequest 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/unavailabletimes
Update agent unavailable times
patchWorkforcemanagementUnavailabletimes 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/unavailabletimes/validation/jobs
Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week
postWorkforcemanagementUnavailabletimesValidationJobs 1 param → 200202400401403404408409
POST
/api/v2/workforcemanagement/unavailabletimes/query
Get agent unavailable times
postWorkforcemanagementUnavailabletimesQuery 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/unavailabletimes/settings
Get availability management unit's settings for agent
getWorkforcemanagementUnavailabletimesSettings → 200400401403404408409413
GET
/api/v2/workforcemanagement/unavailabletimes/validation/jobs/{jobId}
Query agent unavailable times validation job
getWorkforcemanagementUnavailabletimesValidationJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/workplanbids/{bidId}/preferences
Gets an agent's work plan bidding preference
getWorkforcemanagementWorkplanbidPreferences 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/workplanbids/{bidId}/preferences
Update an agent's work plan bidding preference
patchWorkforcemanagementWorkplanbidPreferences 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/workplanbids/{bidId}/workplans
Gets an agent's work plans for a bid
getWorkforcemanagementWorkplanbidWorkplans 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/workplanbids
Gets the list of work plan bids that belong to an agent
getWorkforcemanagementWorkplanbids → 200400401403404408409413
GET
/api/v2/workforcemanagement/alternativeshifts/settings
Get alternative shifts settings from the current logged in agent’s business unit
getWorkforcemanagementAlternativeshiftsSettings → 200400401403404408409413
POST
/api/v2/workforcemanagement/agentschedules/mine
Get published schedule for the current user
postWorkforcemanagementAgentschedulesMine 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agentschedules/managementunits/mine
Fetch agent schedules for the logged in user's management unit
postWorkforcemanagementAgentschedulesManagementunitsMine 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/schedulesdeprecated
Get published schedule for the current user
postWorkforcemanagementSchedules 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/shifttradesdeprecated
Gets all of my shift trades
getWorkforcemanagementShifttrades → 200400401403404408409413
POST
/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query
Retrieves integration statuses for a list of current user time off requests
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/notifications
Get a list of notifications for the current user
getWorkforcemanagementNotifications → 200400401403404408409413
POST
/api/v2/workforcemanagement/notifications/update
Mark a list of notifications as read or unread
postWorkforcemanagementNotificationsUpdate 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}
Retrieves delete job status for historical data imports associated with the job id
getWorkforcemanagementHistoricaldataBulkRemoveJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs
Retrieves all delete job status for historical data
getWorkforcemanagementHistoricaldataBulkRemoveJobs → 200400401403404408409413
POST
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs
Delete the list of the historical data import entries
postWorkforcemanagementHistoricaldataBulkRemoveJobs 1 param → 202400401403404408409413
GET
/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}
Retrieves status of the historical data imports associated with job id
getWorkforcemanagementHistoricaldataImportstatusJobId 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/historicaldata/importstatus
Retrieves status of the historical data imports of the organization
getWorkforcemanagementHistoricaldataImportstatus → 200400401403404408409413
POST
/api/v2/workforcemanagement/historicaldata/validate
Trigger validation process for historical import
postWorkforcemanagementHistoricaldataValidate 1 param → 202400401403404408409413
POST
/api/v2/workforcemanagement/agents/integrations/hris/query
Query integrations for agents
postWorkforcemanagementAgentsIntegrationsHrisQuery 1 param → 200400401403404408409413
PUT
/api/v2/workforcemanagement/agents/{agentId}/integrations/hris
Update integrations for agent
putWorkforcemanagementAgentIntegrationsHris 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}
Query the results of time off types job
getWorkforcemanagementIntegrationsHrisTimeofftypesJob 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/integrations/hris
Get integrations
getWorkforcemanagementIntegrationsHris → 200400401403404408409413
POST
/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs
Get list of time off types configured in integration
postWorkforcemanagementIntegrationsHriTimeofftypesJobs 1 param → 200202400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings
Get minimum staffing settings for a business unit
getWorkforcemanagementBusinessunitMinimumstaffingSettings 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings
Update minimum staffing settings for a business unit
patchWorkforcemanagementBusinessunitMinimumstaffingSettings 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add
Bulk add enrollments to opportunities for the authenticated agent
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update
Bulk update enrollment status for the authenticated agent
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/agents/opportunities/query
Query opportunities for the authenticated agent
postWorkforcemanagementAgentsOpportunitiesQuery 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update
Bulk update enrollment status
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query
Query enrollments
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query
Query opportunities within the specified date range
postWorkforcemanagementBusinessunitOpportunitiesQuery 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query
Query opportunities by external activity IDs
postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add
Bulk add opportunities
postWorkforcemanagementBusinessunitOpportunitiesBulkAdd 2 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove
Bulk remove opportunities
postWorkforcemanagementBusinessunitOpportunitiesBulkRemove 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish
Bulk publish opportunities
postWorkforcemanagementBusinessunitOpportunitiesBulkPublish 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update
Bulk update opportunities status
postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}
Get opportunity details
getWorkforcemanagementBusinessunitOpportunity 3 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}
Update the opportunity
patchWorkforcemanagementBusinessunitOpportunity 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations
Request a daily recalculation of the performance prediction for the associated schedule
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations 4 params → 200202400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}
Get recalculated performance prediction result
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions
Get the performance prediction for the associated schedule
getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl
Upload daily activity changes to be able to request a performance prediction recalculation
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary
Get summary of bid groups that belong to a schedule bid
getWorkforcemanagementBusinessunitSchedulebidGroupsSummary 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Get a schedule bid group
getWorkforcemanagementBusinessunitSchedulebidGroup 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Delete a schedule bid group by bid group Id
deleteWorkforcemanagementBusinessunitSchedulebidGroup 3 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Update a schedule bid group by bid group Id
patchWorkforcemanagementBusinessunitSchedulebidGroup 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups
Add a bid group in a given schedule bid
postWorkforcemanagementBusinessunitSchedulebidGroups 3 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences
Get agents schedule bid preferences for a bid group
getWorkforcemanagementBusinessunitSchedulebidGroupPreferences 5 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences
Overrides the assigned schedule bid for the specified agents
patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Get a schedule bid
getWorkforcemanagementBusinessunitSchedulebid 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Delete a schedule bid
deleteWorkforcemanagementBusinessunitSchedulebid 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Update a schedule bid
patchWorkforcemanagementBusinessunitSchedulebid 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids
Get list of schedule bids
getWorkforcemanagementBusinessunitSchedulebids 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids
Create a new schedule bid
postWorkforcemanagementBusinessunitSchedulebids 2 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy
Copy a schedule bid
postWorkforcemanagementBusinessunitSchedulebidCopy 3 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets
Fetch all the agents with effective schedule set for the given BU
postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs
Get the list of scheduling runs
getWorkforcemanagementBusinessunitSchedulingRuns 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Get a scheduling run
getWorkforcemanagementBusinessunitSchedulingRun 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Cancel a scheduling run
deleteWorkforcemanagementBusinessunitSchedulingRun 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Mark a schedule run as applied
patchWorkforcemanagementBusinessunitSchedulingRun 3 params → 204400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result
Get the result of a rescheduling operation
getWorkforcemanagementBusinessunitSchedulingRunResult 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search
Search published schedules
postWorkforcemanagementBusinessunitAgentschedulesSearch 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}
Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
getWorkforcemanagementBusinessunitWeekSchedule 4 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}
Delete a schedule
deleteWorkforcemanagementBusinessunitWeekSchedule 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule
Start a rescheduling run
postWorkforcemanagementBusinessunitWeekScheduleReschedule 4 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl
Creates a signed upload URL for updating a schedule
postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl 4 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules
Get the list of week schedules for the specified week
getWorkforcemanagementBusinessunitWeekSchedules 6 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules
Create a blank schedule
postWorkforcemanagementBusinessunitWeekSchedules 3 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl
Creates a signed upload URL for importing a schedule
postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl 3 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import
Starts processing a schedule import
postWorkforcemanagementBusinessunitWeekSchedulesImport 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate
Generate a schedule
postWorkforcemanagementBusinessunitWeekSchedulesGenerate 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy
Copy a schedule
postWorkforcemanagementBusinessunitWeekScheduleCopy 4 params → 200201202400401403404408
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults
Get the generation results for a generated schedule
getWorkforcemanagementBusinessunitWeekScheduleGenerationresults 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast
Get the headcount forecast by planning group for the schedule
getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query
Loads agent schedule data from the schedule. Used in combination with the metadata route
postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery 6 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}
Loads agent's schedule history.
getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update
Starts processing a schedule update
postWorkforcemanagementBusinessunitWeekScheduleUpdate 4 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/searchdeprecated
Query published schedules for given given time range for set of users
postWorkforcemanagementManagementunitSchedulesSearch 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search
Query published schedules for given given time range for set of users
postWorkforcemanagementManagementunitAgentschedulesSearch 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedulesdeprecated
Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
getWorkforcemanagementManagementunitWeekSchedules 5 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}deprecated
Deprecated. Use the equivalent business unit resource instead. Get a week schedule
getWorkforcemanagementManagementunitWeekSchedule 5 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings
Get scheduler settings for a business unit
getWorkforcemanagementBusinessunitSchedulerSettings 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings
Update scheduler settings for a business unit
patchWorkforcemanagementBusinessunitSchedulerSettings 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/schedulingjobs/{jobId}
Get status of the scheduling job
getWorkforcemanagementSchedulingjob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs
Queries shift trades in a management unit per user
postWorkforcemanagementBusinessunitShifttradingTradesQueryJobs 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs/{jobId}
View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status
getWorkforcemanagementBusinessunitShifttradingTradesQueryJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs
Queries and evaluates against shift trade configuration shift trades in a management unit per week
postWorkforcemanagementBusinessunitShifttradingTradesEvaluateJobs 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs/{jobId}
View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status
getWorkforcemanagementBusinessunitShifttradingTradesEvaluateJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs
Retrieves the summary of shift trades in a matched state per week
postWorkforcemanagementBusinessunitShifttradingWeeksSummaryJobs 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs/{jobId}
View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status
getWorkforcemanagementBusinessunitShifttradingWeeksSummaryJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs
Start an async job to find potential shift trade matches for the current receiving user
postWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJobs 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs/{jobId}
View result of potential shift trade matches for the current user. Only the user who started the operation can query the status
getWorkforcemanagementBusinessunitShifttradingUnmatchedSearchJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs
Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades.
postWorkforcemanagementBusinessunitShifttradingTradesStateBulkJobs 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs/{jobId}
View results of bulk update trades states operation. Only the user who started the operation can query the status.
getWorkforcemanagementBusinessunitShifttradingTradesStateBulkJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/shifttrading/trades/jobs
Add a shift trade job
postWorkforcemanagementShifttradingTradesJobs 2 params → 200201202400401403404408
GET
/api/v2/workforcemanagement/shifttrading/trades/jobs/{jobId}
View result of create trade operation. Only the user who started the operation can query the status
getWorkforcemanagementShifttradingTradesJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs
Retrieve all my shift trades where I am either the initiating or receiving user
postWorkforcemanagementShifttradingTradesMineQueryJobs 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/{jobId}
View results of retrieve all my shift trade operation. Only the user who started the operation can query the status
getWorkforcemanagementShifttradingTradesMineQueryJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs
Updates a shift trade. This route can only be called by the initiating user
postWorkforcemanagementShifttradingTradeJobs 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs/{jobId}
View result of update trade operation. Only the user who started the operation can query the status
getWorkforcemanagementShifttradingTradeJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs
Update trade state by a user
postWorkforcemanagementShifttradingTradeStateJobs 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs/{jobId}
View result of update trade state operation. Only the user who started the operation can query the status.
getWorkforcemanagementShifttradingTradeStateJob 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs
Matches a shift trade. This route can only be called by the receiving user
postWorkforcemanagementShifttradingTradeMatchJobs 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs/{jobId}
View result of match shift trade operation. Only the receiving user who started the operation can query the status.
getWorkforcemanagementShifttradingTradeMatchJob 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/shrinkage/jobs/{jobId}
Request to fetch the status of the historical shrinkage query
getWorkforcemanagementShrinkageJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs
Request a historical shrinkage report
postWorkforcemanagementManagementunitShrinkageJobs 2 params → 202400401403404408409413
POST
/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs
Request a historical shrinkage report
postWorkforcemanagementTeamShrinkageJobs 2 params → 202400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query
Fetches time off requests matching the conditions specified in the request body
postWorkforcemanagementManagementunitTimeoffrequestsQuery 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests
Get a list of time off requests for a given user
getWorkforcemanagementManagementunitUserTimeoffrequests 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}
Get a time off request
getWorkforcemanagementManagementunitUserTimeoffrequest 3 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}
Update a time off request
patchWorkforcemanagementManagementunitUserTimeoffrequest 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests
Create a new time off request
postWorkforcemanagementManagementunitTimeoffrequests 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/timeoffbalance/jobs
Query time off balances for the current user for specified activity code and dates
postWorkforcemanagementTimeoffbalanceJobs 1 param → 200202400401403404408409
GET
/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}
Query the results of time off types job
getWorkforcemanagementTimeoffbalanceJob 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs
Query time off balances for dates spanned by a given time off request
postWorkforcemanagementManagementunitUserTimeoffrequestTimeoffbalanceJobs 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs
Query time off balances for a given user for specified activity code and dates
postWorkforcemanagementManagementunitUserTimeoffbalanceJobs 3 params → 200202400401403404408409
POST
/api/v2/workforcemanagement/timeoffrequests/estimate
Estimates available time off for current user
postWorkforcemanagementTimeoffrequestsEstimate 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate
Estimates available time off for an agent
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query
Retrieves integration statuses for a list of time off requests
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery 2 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus
Set integration status for a time off request.
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits
Gets a list of time-off limit objects
getWorkforcemanagementBusinessunitTimeofflimits 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits
Creates a new time-off limit object
postWorkforcemanagementBusinessunitTimeofflimits 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}
Gets a time-off limit object
getWorkforcemanagementBusinessunitTimeofflimit 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}
Deletes a time-off limit object
deleteWorkforcemanagementBusinessunitTimeofflimit 2 params → 204400401403404408409413
PUT
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values
Sets daily values for a date range of time-off limit object
putWorkforcemanagementBusinessunitTimeofflimitValues 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query
Retrieves time-off limit related values based on a given set of filters.
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits
Gets a list of time off limit objects under management unit.
getWorkforcemanagementManagementunitTimeofflimits 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits
Creates a new time off limit object under management unit.
postWorkforcemanagementManagementunitTimeofflimits 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
Gets a time off limit object
getWorkforcemanagementManagementunitTimeofflimit 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
Deletes a time off limit object
deleteWorkforcemanagementManagementunitTimeofflimit 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
Updates a time off limit object.
patchWorkforcemanagementManagementunitTimeofflimit 3 params → 200400401403404408409413
PUT
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values
Sets daily values for a date range of time off limit object
putWorkforcemanagementManagementunitTimeofflimitValues 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query
Retrieves time off limit related values based on a given set of filters.
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits
Retrieves time off limit, allocated and waitlisted values according to specific time off request
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans
Gets a list of time-off plans
getWorkforcemanagementBusinessunitTimeoffplans 4 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans
Creates a new time-off plan
postWorkforcemanagementBusinessunitTimeoffplans 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}
Gets a time-off plan
getWorkforcemanagementBusinessunitTimeoffplan 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}
Deletes a time-off plan
deleteWorkforcemanagementBusinessunitTimeoffplan 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}
Updates a time-off plan
patchWorkforcemanagementBusinessunitTimeoffplan 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans
Gets a list of time off plans
getWorkforcemanagementManagementunitTimeoffplans 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans
Creates a new time off plan
postWorkforcemanagementManagementunitTimeoffplans 2 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
Gets a time off plan
getWorkforcemanagementManagementunitTimeoffplan 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
Deletes a time off plan
deleteWorkforcemanagementManagementunitTimeoffplan 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
Updates a time off plan
patchWorkforcemanagementManagementunitTimeoffplan 3 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query
Retrieves daily waitlist position for a list of time off requests
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary
Get summary of bid groups that belong to a work plan bid
getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary 2 params → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups
Add a bid group in a given work plan bid
postWorkforcemanagementBusinessunitWorkplanbidGroups 3 params → 200201400401403404408409
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}
Get a bid group by bid group Id
getWorkforcemanagementBusinessunitWorkplanbidGroup 3 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}
Delete a bid group by bid group Id
deleteWorkforcemanagementBusinessunitWorkplanbidGroup 3 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}
Update a bid group by bid group Id
patchWorkforcemanagementBusinessunitWorkplanbidGroup 4 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences
Gets the work plan preferences of all the agents in the work plan bid group
getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences 3 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences
Overrides the assigned work plan for the specified agents
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences 4 params → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/users/workplanbidranks/bulk
Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
patchWorkforcemanagementUsersWorkplanbidranksBulk 1 param → 200400401403404408409413
GET
/api/v2/workforcemanagement/users/{userId}/workplanbidranks
Get work plan bid ranks for a user
getWorkforcemanagementUserWorkplanbidranks 1 param → 200400401403404408409413
PATCH
/api/v2/workforcemanagement/users/{userId}/workplanbidranks
Update work plan bid ranks for a user
patchWorkforcemanagementUserWorkplanbidranks 2 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}
Get a work plan bid
getWorkforcemanagementBusinessunitWorkplanbid 2 params → 200400401403404408409413
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}
Delete a work plan bid
deleteWorkforcemanagementBusinessunitWorkplanbid 2 params → 204400401403404408409413
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}
Update work plan bid
patchWorkforcemanagementBusinessunitWorkplanbid 3 params → 200400401403404408409413
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids
Get list of work plan bids
getWorkforcemanagementBusinessunitWorkplanbids 1 param → 200400401403404408409413
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids
Create a new work plan bid
postWorkforcemanagementBusinessunitWorkplanbids 2 params → 200201400401403404408409
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy
Copy a work plan bid
postWorkforcemanagementBusinessunitWorkplanbidCopy 3 params → 200201400401403404408409

Schemas 773

The contract defines 773 schemas that model the data the API accepts and returns. The most detailed are WorkPlan (36 properties), WorkPlanListItemResponse (36 properties), WorkPlanValidationRequest (35 properties), CreateWorkPlan (31 properties). Each schema is shown below with its type and property counts.

RequiredDateRange
object
2 properties 2 required
SchedulingPeriodBase
object
1 property 1 required
WeekShiftTradeListResponse
object
2 properties
BuAgentScheduleHistoryDeletedChange
object
3 properties
UploadUrlRequestBody
object
1 property 1 required
AdherenceSettings
object
7 properties
CreateStaffingGroupRequest
object
4 properties 1 required
CreateTimeOffPlanRequest
object
7 properties 3 required
MuRescheduleResultWrapper
object
1 property
BuUpdateAgentScheduleUploadSchema
object
7 properties 1 required
GenerateBuForecastRequest
object
3 properties 1 required
ValidationServiceRequest
object
2 properties 2 required
IgnoredActivityCodeIds
object
1 property
OpportunityResult
object
19 properties 13 required
ActivityPlanServiceGoalImpactOverrides
object
3 properties 3 required
WeekScheduleResponse
object
2 properties
ActivityPlanListing
object
1 property
BulkUpdateShiftTradeListJobRequest
object
3 properties 3 required
AlternativeShiftAsyncResponse
object
1 property 1 required
TimeOffIntegrationStatusResponse
object
2 properties 2 required
ShrinkageOverride
object
2 properties 1 required
ReschedulingOptionsRunResponse
object
10 properties
ShiftTradeEvaluateTradesBuJobResponse
object
7 properties 3 required
WfmUserEntityListing
object
1 property
BulkOpportunityEnrollmentsStatusUpdateRequest
object
3 properties 2 required
ShiftTradeResponseItem
object
11 properties 6 required
BuUpdateAgentScheduleShift
object
9 properties
CreateBusinessUnitSettingsRequest
object
7 properties 2 required
WfmAgentHistoricalAdherenceResult
object
13 properties 7 required
UpdateMuAgentsRequest
object
1 property
TimeOffRequestLookup
object
2 properties 2 required
AlternativeShiftTradeListing
object
1 property
BuQueryAdherenceExplanationsRequest
object
4 properties 2 required
OverrideDate
object
2 properties 2 required
SetWrapperDayOfWeek
object
1 property
BuIntradayDataGroup
object
7 properties
UserStaffingGroupResponse
object
2 properties
ShiftTradeQueryWeekSummariesBuJobResponse
object
7 properties 3 required
ValidateAgentUnavailableTimesResponse
object
3 properties 1 required
UpdateNotificationsRequest
object
1 property 1 required
StaffingGroupReference
object
2 properties 1 required
TeamReference
object
2 properties
BuHeadcountForecastBuPlanningGroupHeadcountForecastResult
object
2 properties
ScheduleSetError
object
3 properties 1 required
UpdateAgentWorkPlanBiddingPreference
object
2 properties 2 required
CapacityPlanDeleteRequest
object
1 property 1 required
SearchShiftTradeResponse
object
3 properties
AddOpportunityBody
object
9 properties 7 required
BuAgentScheduleQueryResponse
object
6 properties
BuScheduleRunListing
object
1 property
CapacityPlanMetricsSummary
object
13 properties 12 required
ShiftTradePreviewResponse
object
1 property
BuQueryAgentSchedulesRequest
object
3 properties 1 required
HistoricalShrinkageAggregateResponse
object
8 properties
WorkPlanShift
object
26 properties 1 required
HistoricalShrinkageResultListing
object
1 property
BulkAddOpportunitiesRequest
object
2 properties 1 required
SetTimeOffLimitValuesRequest
object
2 properties 1 required
UpdateTimeOffPlanBusinessUnitAssociation
object
2 properties
ValidateWorkPlanMessages
object
2 properties
WorkPlanBid
object
Work plan bid response
15 properties 11 required
StaffingRequirementsPlanningGroupData
object
4 properties 2 required
TimeOffLimitReference
object
2 properties 1 required
PlanningGroupOutputs
object
5 properties 5 required
CreateTimeOffPlanManagementUnitAssociation
object
2 properties 1 required
TimeOffLimitRange
object
3 properties 3 required
UserScheduleAdherenceListing
object
2 properties
AgentAssignedShiftSet
object
4 properties 4 required
UpdateTimeOffLimitRequest
object
2 properties 1 required
AgentMuQueryResponse
object
5 properties 2 required
SearchShiftTradesResponse
object
2 properties
AlternativeShiftJobResponse
object
9 properties 2 required
AdherenceExplanationListingBuQueryResponse
object
1 property
ScheduleBidGroup
object
8 properties 4 required
QueryWaitlistPositionsRequest
object
1 property 1 required
BuAgentScheduleShift
object
8 properties
AlternativeShiftOffersRequest
object
2 properties 2 required
AgentMuScheduleItem
object
3 properties 3 required
WfmHistoricalAdherenceBulkItem
object
6 properties 3 required
AgentsIntegrationsListing
object
1 property
AdminTimeOffRequestPatch
object
12 properties 1 required
ShiftTradeQueryTradesBuJobResponse
object
7 properties 3 required
QueryAgentUnavailableTimesRequest
object
2 properties 2 required
ManagementUnitSettingsRequest
object
6 properties 1 required
MinimumStaffingRequest
object
4 properties
CreateBusinessUnitRequest
object
3 properties 3 required
ForecastServiceGoalTemplateImpactOverrideResponse
object
3 properties
AdminAgentScheduleBidPreferenceResponse
object
2 properties
ScheduleGenerationMessage
object
2 properties
AdherenceExplanationListing
object
1 property
CreateCapacityPlanStaffingGroupMetricChangeRequest
object
8 properties 6 required
MoveManagementUnitRequest
object
1 property 1 required
AgentQueryAdherenceExplanationsRequest
object
2 properties 2 required
BuAlternativeShiftJobResponse
object
9 properties 3 required
BuAgentScheduleHistoryChange
object
4 properties
BulkOpportunitiesEnrollmentResult
object
3 properties 2 required
UnavailableTimesManagementUnitSettings
object
2 properties 2 required
AgentWorkPlanActivity
object
2 properties 2 required
BuForecastResult
object
4 properties
AgentQueryOpportunityResult
object
12 properties 9 required
CurrentUserScheduleRequestBody
object
3 properties 2 required
ManagementUnitListing
object
10 properties
ShiftTradeActivityPreviewResponse
object
7 properties
BulkPublishOpportunitiesResponse
object
2 properties 2 required
UpdateWorkPlanBid
object
Update work plan bid model
10 properties
BuAsyncAgentSchedulesQueryResponse
object
5 properties
LongTermRequirementsServiceGoalDetail
object
2 properties 2 required
QueryCapacityPlanStaffingGroupMetricChangeHistory
object
2 properties 1 required
QueryShiftTradeListJobRequest
object
3 properties 3 required
TimeOffRequestQueryBody
object
5 properties
StaffingGroupListing
object
2 properties
ValueWrapperString
object
1 property
ReschedulingManagementUnitResponse
object
2 properties
QueryUserStaffingGroupListRequest
object
1 property 1 required
AgentBulkAddOpportunityEnrollmentResult
object
3 properties 2 required
AdherenceExplanationResponse
object
12 properties 7 required
WorkPlanBidGroupCreate
object
5 properties 5 required
ValidateWorkPlanResponse
object
3 properties
WorkPlanListResponse
object
1 property
ScheduleBidGroupReference
object
2 properties 1 required
AgentBulkStatusUpdateOpportunityEnrollmentsRequest
object
2 properties 2 required
AdherenceExplanationAsyncResponse
object
1 property
ListWrapperInteger
object
1 property
MatchShiftTradeJobRequest
object
4 properties 3 required
AdherenceExplanationListingAgentQueryResponse
object
1 property
ScheduleBidScheduledShift
object
5 properties 3 required
BuForecastTimeSeriesResult
object
3 properties
ImportForecastUploadResponse
object
4 properties
UserSchedule
object
5 properties 1 required
ListWrapperBidGroupWorkPlanRotationRequest
object
1 property
UnavailableTime
object
3 properties 1 required
AgentWorkPlanBiddingPreferenceRequest
object
2 properties 1 required
WeekShiftTradeResponse
object
2 properties
QueryTimeOffLimitValuesResponse
object
1 property
ScheduleBidGroupUpdate
object
7 properties
BuScheduleMetadata
object
10 properties
BusinessUnitActivityCode
object
16 properties 1 required
BulkRemoveOpportunitiesResponse
object
2 properties 2 required
InitiatingAlternativeShift
object
2 properties 2 required
LongTermForecastResult
object
3 properties
GetAgentsWorkPlansRequest
object
3 properties 3 required
PatchShiftTradeRequest
object
4 properties 1 required
BuTimeOffLimitReference
object
2 properties 1 required
BuServiceLevel
object
3 properties 1 required
SetWrapperRoutePathRequest
object
1 property
WaitlistPositionListing
object
1 property
ConstraintConflictMessage
object
2 properties
AdminAgentScheduleSetPreferences
object
5 properties 2 required
BuQueryAdherenceExplanationsResponse
object
3 properties
ScheduleBid
object
16 properties 12 required
CreateWorkPlan
object
31 properties 1 required
EstimateAvailableFullDayTimeOffRequest
object
2 properties 1 required
WorkPlanPatternResponse
object
1 property
UpdateBusinessUnitRequest
object
3 properties
QueueReference
object
2 properties
UserStaffingGroupListing
object
2 properties
AgentsBidAssignedScheduleSetOverrideRequest
object
1 property 1 required
BuNotificationSettingsResponse
object
1 property
BuRescheduleResult
object
5 properties
BuScheduleListItem
object
9 properties
HistoricalShrinkageResult
object
7 properties
HrisTimeOffTypesJobReference
object
3 properties
UpdateUnavailableTimesRequest
object
1 property 1 required
HrisTimeOffTypeResponse
object
3 properties 2 required
AddWorkPlanRotationAgentRequest
object
3 properties 3 required
ErrorBody
object
11 properties
AgentScheduleBid
object
8 properties 6 required
BuAverageSpeedOfAnswer
object
2 properties 1 required
AgentBulkAddOpportunityEnrollment
object
2 properties 1 required
StaffingGroupMetricChangeResponse
object
9 properties 7 required
LongTermRequirements
object
4 properties 3 required
TimeOffRequestListing
object
2 properties 1 required
PlanningPeriodSettings
object
2 properties 2 required
AgentIntegrationAssociationRequest
object
3 properties 3 required
UpdateMuAgentWorkPlanRequest
object
3 properties 1 required
ListWrapperRequiredDateRange
object
1 property
CreateWorkPlanActivity
object
14 properties
UpdateBusinessUnitSettingsRequest
object
8 properties 1 required
ActivityPlanServiceLevelImpactOverride
object
1 property 1 required
BuSetTimeOffLimitValuesRequest
object
2 properties 1 required
WorkPlanBidGroup
object
5 properties 5 required
UserSearchRulePart
object
3 properties 3 required
QueryAvailabilityManagementUnitsSettingsRequest
object
1 property 1 required
ListWrapperShiftStartVariance
object
1 property
TimeOffRequest
object
23 properties 2 required
AgentScheduleShiftActivity
object
3 properties 3 required
WfmHistoricalAdherenceBulkQuery
object
2 properties 2 required
HistoricalAdherenceDayMetrics
object
11 properties
ShiftSetEffectiveWorkPlan
object
3 properties
CurrentUserTimeOffIntegrationStatusRequest
object
1 property 1 required
AsyncForecastOperationResult
object
4 properties
CapacityPlanForecastMetrics
object
2 properties 2 required
ValueWrapperActivityPlanServiceGoalImpactOverrides
object
1 property
CreateAlternativeShiftTradeRequest
object
5 properties 2 required
BuScheduleRun
object
18 properties 1 required
ShiftTradeMatchTradeJobResponse
object
7 properties 3 required
StaffingRequirementResultResponseTemplate
object
1 property 1 required
ValueWrapperDate
object
1 property
AdminAgentWorkPlanBiddingPreference
object
6 properties 2 required
ShiftTradeResponse
object
19 properties
PendingAndApprovedOpportunityEnrollmentCounts
object
2 properties 2 required
ScheduleBidGroupResponse
object
4 properties 3 required
BuForecastGenerationPlanningGroupResult
object
2 properties
AddShiftTradeRequest
object
5 properties 2 required
ActivityPlanJobException
object
2 properties 2 required
BuScheduleNotificationsCategorySettings
object
3 properties 3 required
BuImportShortTermForecastSchema
object
5 properties 3 required
PatchBuReschedulingOptionsManagementUnitRequest
object
2 properties 1 required
SetWrapperString
object
1 property
BuShortTermForecast
object
16 properties 1 required
AssignedAgentDetails
object
2 properties 1 required
ActivityCodesReference
object
2 properties
ScheduleBidGroupSummary
object
9 properties 7 required
QueryWeekSummaryListJobRequest
object
2 properties 2 required
AgentTimeOffRequestPatch
object
5 properties
CopyCapacityPlanRequest
object
5 properties 3 required
AgentAdherenceScheduledActivity
object
3 properties 3 required
ActivityPlanOccurrenceReference
object
2 properties 1 required
OpportunityResultWithAgentIds
object
20 properties 13 required
HistoricalDataDeleteEntity
object
2 properties
BulkOpportunitiesExternalActivitiesRequest
object
1 property 1 required
SetWrapperSyncTimeOffProperty
object
1 property
BuAsyncAgentSchedulesSearchResponse
object
5 properties
SetTimeOffIntegrationStatusRequest
object
1 property 1 required
WfmHistoricalAdherenceQueryForTeams
object
5 properties 2 required
SchedulingSettingsRequest
object
6 properties
InitiatingShiftRequestItem
object
3 properties 3 required
ValueWrapperShiftTradeTargetRequestItem
object
1 property
ImportForecastResponse
object
3 properties
HistoricalAdherenceActuals
object
4 properties
CreateAgentTimeOffRequest
object
9 properties 1 required
ScheduleBidGroupSummaryList
object
1 property 1 required
ListWrapperAgentWorkPlanField
object
1 property
UserSearchRule
object
1 property 1 required
UpdateScheduleBid
object
10 properties
TimeOffPlanListing
object
1 property
AgentMuScheduleQuery
object
2 properties 2 required
ForecastServiceLevelResponse
object
2 properties
CreateStaffingGroupAllocation
object
4 properties 4 required
WfmHistoricalAdherenceBulkResult
object
5 properties
QueryOpportunityEnrollmentResult
object
9 properties 4 required
AlternativeShiftOffersViewResponseTemplate
object
8 properties 8 required
BusinessUnitSettingsResponse
object
8 properties 3 required
SearchAlternativeShiftTradesRequest
object
2 properties
AdherenceExplanationNotification
object
10 properties
WorkPlanReference
object
3 properties
BuIntradayScheduleData
object
1 property
QueryOpportunitiesResponse
object
2 properties
WorkPlanBidGroupSummaryList
object
1 property 1 required
LongTermForecastPlanningGroupData
object
3 properties 3 required
ListWrapperInterval
object
1 property
BuShortTermForecastReference
object
4 properties 1 required
BuScheduleListing
object
1 property
MoveAgentsResponse
object
3 properties
BuAgentScheduleShiftRequest
object
8 properties
AgentMuScheduleResult
object
2 properties 2 required
AgentQueryAdherenceExplanationsResponse
object
3 properties
BulkUpdateShiftTradeStateResultItem
object
6 properties
FixedAvailability
object
3 properties
MatchShiftTradeResponse
object
4 properties
PlanningGroupToStaffingGroupsResponse
object
2 properties 1 required
BuAgentSchedulePublishedScheduleReference
object
4 properties
QueryAgentUnavailableTimesValidationJobResponse
object
6 properties 2 required
ServiceGoalTemplateImpactOverride
object
2 properties 2 required
SchedulingOptionsRequest
object
3 properties
CapacityPlanStaffingGroupMetricChangeHistoryListResponse
object
1 property
BuScheduleReference
object
3 properties
ActivityPlanRunJobResponse
object
6 properties 4 required
PlanningGroupToStaffingGroupsListing
object
1 property
WaitlistPosition
object
4 properties
BulkUpdateShiftTradeStateRequestItem
object
3 properties 2 required
TimeOffRequestReference
object
2 properties
AdminBulkUpdateAlternativeShiftTradeStateRequest
object
2 properties 1 required
LongTermRequirementsServiceGoal
object
7 properties 7 required
AgentQueryOpportunities
object
2 properties 1 required
EstimateAvailablePartialDayTimeOffRequest
object
2 properties 1 required
UpdatePlanningGroupRequest
object
4 properties 1 required
WfmHistoricalAdherenceQuery
object
6 properties 1 required
ShiftTradeInitiatingSideResponseItem
object
4 properties 4 required
AlternativeShiftBuSettingsResponse
object
4 properties 4 required
BuShortTermForecastListItem
object
9 properties 1 required
BuTimeOffPlanListing
object
2 properties
ValueWrapperUserSearchRule
object
1 property
SchedulingStatusResponse
object
5 properties
BuAbandonRate
object
2 properties 1 required
AgentBidScheduleSetOverrideRequest
object
3 properties 1 required
SearchUnmatchedShiftTradeResponseItem
object
2 properties 2 required
BuAgentSchedulesSearchResponse
object
3 properties
AddAdherenceExplanationAgentRequest
object
4 properties 3 required
UpdateTimeOffPlanRequest
object
8 properties 1 required
WorkPlanConstraintConflictMessage
object
2 properties
ShiftTradeExternalActivityRule
object
3 properties 2 required
WfmIntegrationListing
object
1 property
UpdateScheduleUploadSchema
object
6 properties 1 required
ShiftTradeTargetRequestItem
object
1 property
AlternativeShiftTradeBulkUpdateTemplateItem
object
6 properties 3 required
AvailableTimeOffRange
object
6 properties
ShiftTradeTargetResponseItem
object
1 property
ActivityPlanResponse
object
27 properties 16 required
ManagementUnit
object
12 properties
BuAsyncScheduleResponse
object
3 properties
WorkPlanActivity
object
17 properties
HistoricalShrinkageActivityCategoryResponse
object
3 properties
MoveManagementUnitResponse
object
2 properties
QueryWeekSummaryListJobResponseItem
object
1 property 1 required
BuPlanningGroupHeadcountForecastUploadSchema
object
3 properties 1 required
EstimateAvailableTimeOffRequest
object
4 properties 2 required
AgentUpdateAlternativeShiftTradeRequest
object
2 properties 1 required
HrisTimeOffTypesJobResponse
object
2 properties
BulkOpportunitiesError
object
1 property 1 required
LocalDateRange
object
2 properties
WorkPlanOverrideListWrapperWorkPlanOverrideRequest
object
2 properties
ScheduleGenerationWarning
object
8 properties
WfmServiceGoalImpactSettings
object
3 properties 3 required
ValueWrapperGroupSettings
object
1 property
BuIntradayForecastData
object
2 properties
QueryOpportunityEnrollmentsResponse
object
2 properties
AgentsBidAssignedWorkPlanOverrideRequest
object
1 property 1 required
BuShortTermForecastWeekReference
object
5 properties 3 required
HeadcountInterval
object
2 properties 2 required
UpdateTimeOffPlanManagementUnitAssociation
object
1 property
ShiftTradeReceivingSideResponseItem
object
2 properties 1 required
BuAgentScheduleSearchResponse
object
3 properties
ManagementUnitUserListing
object
2 properties 2 required
WfmForecastModificationIntervalOffsetValue
object
2 properties 2 required
WfmTimeSpan
object
2 properties 2 required
ActivityPlanSessionStructureReference
object
3 properties 1 required
TimeOffSettingsResponse
object
5 properties
ShiftTradeActivityRule
object
3 properties 2 required
ScheduleBidGroupCreate
object
6 properties 4 required
BidGroupScheduleSet
object
1 property 1 required
HeadcountForecast
object
2 properties 2 required
BuAgentScheduleActivity
object
10 properties 4 required
BulkRemoveOpportunitiesResult
object
3 properties 2 required
ScheduleGenerationResult
object
5 properties
ShortTermForecastingSettings
object
1 property
ProcessScheduleUpdateUploadRequest
object
3 properties 1 required
PatchBuScheduleRunRequest
object
1 property
ValueWrapperMonthlyPlanningPeriodSettings
object
1 property
DayOfWeekMinimums
object
2 properties 2 required
EvaluateShiftTradeListJobResponseItem
object
1 property
CopyScheduleBid
object
1 property 1 required
BuTimeOffLimitListing
object
1 property
ValueWrapperLocalDate
object
1 property
BuCreateTimeOffPlanRequest
object
12 properties 1 required
CreateServiceGoalTemplate
object
5 properties 1 required
CreateActivityPlanRequest
object
19 properties 9 required
AgentManagementUnitReference
object
3 properties
AgentEffectiveBid
object
7 properties 3 required
AlternativeShiftTradeResponse
object
17 properties 9 required
BuForecastResultResponse
object
2 properties
AgentOpportunityEnrollmentResult
object
7 properties 2 required
ShiftTradeUpdateTradeJobResponse
object
7 properties 3 required
CapacityPlanResponse
object
9 properties 5 required
UpdateNotificationResponse
object
2 properties
CapacityPlanReference
object
3 properties 1 required
WfmHistoricalShrinkageResponse
object
4 properties
ActivityCode
object
11 properties 2 required
AgentMuScheduleShift
object
3 properties 3 required
EstimateAvailableFullDayTimeOffResponse
object
7 properties 4 required
MatchShiftTradeRequest
object
3 properties 2 required
TimeOffLimitValueRange
object
8 properties 2 required
SecondaryPresenceLookupItem
object
2 properties
AdherenceExplanationJobReference
object
4 properties
TimeOffBalanceJobReference
object
3 properties
ShiftTradeUpdateTradeStateJobResponse
object
7 properties 3 required
QueryAgentsIntegrationsRequest
object
Query integrations for agents request
1 property 1 required
BuForecastModificationResponse
object
13 properties 7 required
SchedulingNoForecastOptionsRequest
object
2 properties
AgentBulkAddOpportunityEnrollmentsRequest
object
1 property 1 required
OpportunityEnrollment
object
1 property
LongTermForecastResultResponse
object
2 properties
LongTermRequirementsErrorDetail
object
2 properties 2 required
CreateActivityCodeRequest
object
11 properties 2 required
ShiftSet
object
6 properties 5 required
ValueWrapperHrisTimeOffType
object
1 property
WorkPlanBidGroupUpdate
object
5 properties
CapacityPlanStaffingGroupAllocationsResponse
object
4 properties 3 required
HistoricalShrinkageActivityCodeResponse
object
2 properties
ActivityPlanAbandonRateImpactOverride
object
1 property 1 required
RoutePathRequest
object
5 properties 2 required
WorkPlanBidRanks
object
4 properties
TimeOffBalanceRequest
object
2 properties 1 required
AgentBulkStatusUpdateOpportunityEnrollmentsResponse
object
2 properties 2 required
UnavailableTimesViolationMessageArgument
object
2 properties 2 required
TimeOffRequestList
object
4 properties
CapacityPlanStaffingRequirementResult
object
8 properties 5 required
DateRange
object
2 properties
AgentsEffectiveScheduleSetResponse
object
1 property 1 required
BuHeadcountForecastResponse
object
2 properties
ValueWrapperInstant
object
1 property
BuRescheduleRequest
object
12 properties 5 required
AgentWorkPlanBids
object
4 properties 1 required
UpdateScheduleUploadResponse
object
4 properties
HistoricalImportDeleteFilesJobResponse
object
5 properties
TimeOffRequestResponse
object
25 properties 1 required
ActivityPlanOccurrenceSessionsUsersStructureReference
object
3 properties 2 required
StaffingGroupAllocationsResponseTemplate
object
4 properties 1 required
ListWrapperPlanningGroupMinimumsRequest
object
1 property
AgentPossibleWorkShiftsRequest
object
2 properties 2 required
WorkPlanRotationListResponse
object
1 property
UserScheduleShift
object
7 properties
AgentIntegrationAssociationResponse
object
3 properties 3 required
UpdateUnavailableTime
object
4 properties
TimeOffBalancesResponse
object
2 properties
HistoricalImportOverallDeleteStatusResponse
object
2 properties
ShrinkageOverrides
object
2 properties
PatchBuReschedulingOptionsRequest
object
1 property
AgentAdherenceDayMetrics
object
11 properties 7 required
RecurrenceSettingsBase
object
1 property 1 required
PossibleWorkShiftsForWeek
object
2 properties
WorkPlanRotationResponse
object
9 properties 1 required
ShiftTradeAddTradeJobResponse
object
7 properties 3 required
BusinessUnitListing
object
1 property
AddWorkPlanRotationRequest
object
4 properties 3 required
ListWrapperBidGroupWorkPlanRequest
object
1 property
EntityListing
object
1 property
ShiftTradeMatchReviewResponse
object
5 properties
AlternativeShiftAgentScheduledShift
object
5 properties 5 required
ActivityPlanJobListing
object
1 property
WorkPlanRotationAgentResponse
object
3 properties
AsyncIntradayResponse
object
3 properties
BulkShiftTradeStateUpdateRequest
object
1 property 1 required
TimeOffLimit
object
5 properties 1 required
UpdateStaffingGroupRequest
object
4 properties 1 required
CreateWorkPlanShift
object
23 properties 1 required
ScheduleBidReference
object
3 properties 1 required
ForecastSourceDayPointer
object
5 properties
CapacityPlansListResponse
object
1 property
AgentScheduleBids
object
4 properties 2 required
UpdateActivityPlanRequest
object
15 properties
ShortTermForecastReference
object
4 properties 2 required
StaffingGroupFullTimeEquivalentContribution
object
2 properties 2 required
WeekShiftTradeMatchesSummaryResponse
object
3 properties
BuUpdateTimeOffPlanRequest
object
13 properties 1 required
BuAgentSchedulesQueryResponse
object
2 properties
StaffingGroupResponse
object
7 properties 3 required
ForecastAverageSpeedOfAnswerResponse
object
1 property
AgentWorkPlan
object
10 properties 7 required
PlanningGroupRequirementOutput
object
4 properties 1 required
AgentsWorkPlansResponse
object
2 properties
AlternativeShiftTradesViewResponseTemplate
object
1 property
AgentPossibleWorkShiftsResponse
object
5 properties
AgentWorkPlanBiddingPreference
object
2 properties 1 required
HistoricalImportDeleteFilesJobRequest
object
1 property 1 required
BuScheduleNotificationsSettingsRequest
object
2 properties
RealTimeAdherenceExplanation
object
5 properties
MuAgentsWorkPlansResult
object
3 properties 2 required
AgentWorkPlanBiddingPreferenceResponse
object
7 properties 2 required
ImportScheduleUploadSchema
object
6 properties 2 required
AgentBusinessUnitOpportunities
object
3 properties 1 required
AgentScheduleBiddingPreferenceResponse
object
7 properties 2 required
RecurrencePeriod
object
2 properties 2 required
WorkPlanValidationMessageArgument
object
2 properties
ForecastPlanningGroupData
object
3 properties 3 required
BuCopyScheduleRequest
object
3 properties 2 required
WorkPlanOverride
object
3 properties 3 required
BuSchedulingSettingsRequest
object
7 properties
ShiftTradeListJobResponse
object
1 property
DateRangeWithOptionalEnd
object
2 properties 1 required
WfmHistoricalAdherenceQueryForAgent
object
3 properties 1 required
AgentWorkPlanBid
object
Work plan bid reference
9 properties 6 required
EvaluatedShiftTradeResponseItem
object
2 properties 1 required
QueryOpportunitiesRequest
object
1 property 1 required
WfmHistoricalAdherenceBulkJobReference
object
3 properties
ShiftTradeSettings
object
21 properties
CopyWorkPlanBid
object
1 property 1 required
CreateTimeOffLimitRequest
object
2 properties
CapacityPlanListItem
object
6 properties 4 required
SchedulingSettingsResponse
object
6 properties
UpdateWorkPlanRotationRequest
object
6 properties 1 required
ActivityPlanReference
object
2 properties 1 required
Detail
object
4 properties
ValidationServiceAsyncResponse
object
2 properties
GroupSettings
object
4 properties
WfmIntegrationResponse
object
4 properties 1 required
BuHeadcountForecastBuPlanningGroupHeadcountForecastUploadSchema
object
2 properties
WeekScheduleReference
object
3 properties 1 required
ShiftTradeBulkUpdateTradeStateBuJobResponse
object
7 properties 3 required
WorkPlanListItemResponse
object
36 properties 2 required
AdminAgentScheduleBidBiddingPreference
object
7 properties 3 required
UpdateShiftTradeStateJobRequest
object
3 properties 3 required
AlternativeShiftScheduleLookup
object
2 properties 2 required
ForecastServiceGoalTemplateResponse
object
4 properties
ManagementUnitAvailabilitySettingsResponse
object
1 property 1 required
BuForecastGenerationResult
object
1 property
WorkPlanValidationRequest
object
35 properties 1 required
AgentWorkPlans
object
2 properties 2 required
BusinessUnitListItem
object
5 properties
BuTimeOffLimitRange
object
2 properties 1 required
QueryOpportunityEnrollmentMetadata
object
7 properties 1 required
ListAlternativeShiftTradesResponse
object
2 properties
BulkOpportunitiesStatusUpdateResponse
object
2 properties 2 required
OpportunityReference
object
2 properties 1 required
TransfersFullTimeEquivalent
object
2 properties
EstimateAvailableTimeOffResponse
object
5 properties 3 required
BulkAddOpportunitiesResponse
object
1 property 1 required
ForecastAbandonRateResponse
object
1 property
AgentWorkPlanShift
object
13 properties 13 required
BuAsyncScheduleRunResponse
object
3 properties
ActivityPlanJobResponse
object
8 properties 5 required
AddAdherenceExplanationAdminRequest
object
5 properties 3 required
QueryAdherenceExplanationsResponse
object
3 properties
BuForecastStaffingRequirementsResultResponse
object
7 properties 6 required
ActivityCodeSummary
object
4 properties 1 required
UnavailableTimeListing
object
1 property
Limit
object
3 properties
BusinessUnitReference
object
2 properties
QueryTimeOffLimitValuesRequest
object
3 properties 1 required
PlanningPeriodShiftConstraints
object
3 properties
OpportunityEnrollmentCounts
object
4 properties 4 required
UpdateManagementUnitsSettingsRequest
object
1 property
WorkPlanRotationReference
object
2 properties 1 required
CreateScheduleBid
object
9 properties 7 required
UpdateManagementUnitRequest
object
3 properties
WfmProcessUploadRequest
object
1 property 1 required
AgentBulkAddOpportunityEnrollmentsResponse
object
2 properties 2 required
WfmIntradayPlanningGroupListing
object
2 properties
AlternativeShiftBulkUpdateTradesResponseTemplate
object
1 property
HistoricalDataDisallowedDeleteEntity
object
2 properties
PatchOpportunityRequest
object
11 properties 1 required
WorkPlanOverrideRequest
object
4 properties 1 required
WfmAgent
object
12 properties 1 required
ManagementUnitSettingsResponse
object
6 properties 1 required
BulkOpportunitiesStatusUpdateRequest
object
2 properties 2 required
SchedulingProcessingError
object
2 properties
UserScheduleContainer
object
3 properties
CreateWorkPlanBid
object
Create work plan bid model
9 properties 7 required
ScheduleGenerationResultSummary
object
4 properties
UpdateMuAgentWorkPlansBatchRequest
object
1 property
UserTimeOffIntegrationStatusResponseListing
object
1 property
BidGroupWorkPlanRequest
object
4 properties 1 required
WorkPlanBidGroupSummary
object
7 properties 6 required
TimeOffBalanceResponse
object
5 properties 2 required
CopyBuForecastRequest
object
2 properties 2 required
WfmVersionedEntityMetadata
object
5 properties 1 required
ForecastMetadata
object
6 properties
BuImportAgentScheduleUploadSchema
object
5 properties 1 required
WeekSchedule
object
11 properties 1 required
PlanningGroupMinimumsResponse
object
2 properties 2 required
ListWrapperString
object
1 property
WorkPlan
object
36 properties 2 required
EstimateAvailablePartialDayTimeOffResponse
object
5 properties 4 required
BuPlanningGroupHeadcountForecastResult
object
3 properties
BuIntradayResponse
object
8 properties
MoveAgentsRequest
object
2 properties 1 required
UpdateAlternativeShiftBuSettingsRequest
object
4 properties 1 required
BuForecastStaffingRequirementsResult
object
4 properties 3 required
QueryEnrollmentOpportunityResult
object
9 properties 8 required
SearchUnmatchedShiftTradeListJobResponseItem
object
1 property 1 required
WfmAgentHistoricalAdherenceResponse
object
3 properties 1 required
PlanningGroup
object
6 properties 1 required
BuTimeOffLimitValuesResponse
object
1 property
UpdateServiceGoalTemplate
object
6 properties 1 required
BulkOpportunitiesReferenceResult
object
3 properties 2 required
AgentBidWorkPlanOverrideRequest
object
3 properties 1 required
WeekScheduleListResponse
object
1 property
ScheduleBidScheduledActivity
object
6 properties 5 required
TimeOffRequestNotification
object
6 properties
ListWrapperSecondaryPresence
object
1 property
QueryExternalActivityOpportunityResult
object
2 properties
ImportScheduleUploadResponse
object
4 properties
QueryAgentShiftTradeListJobRequest
object
1 property 1 required
DivisionReference
object
2 properties
AgentWorkPlanListResponse
object
2 properties 1 required
QueryAgentScheduleUnavailableTimesRequest
object
2 properties 2 required
WfmAgentHistoricalAdherenceJobReference
object
3 properties
UpdateActivityCodeRequest
object
12 properties 1 required
BuAgentScheduleHistoryResponse
object
4 properties
AgentCountRange
object
2 properties 2 required
UserNextActivityReminder
object
2 properties
IntradayPlanningGroupRequest
object
4 properties 2 required
ScheduleReferenceWithBusinessUnit
object
4 properties 3 required
ForecastPlanningGroupResponse
object
4 properties
HrisTimeOffType
object
4 properties 3 required
PerformancePredictionResponse
object
7 properties 4 required
CapacityPlanStaffingGroupMetricChangeResponse
object
10 properties 8 required
WorkPlanConfigurationViolationMessage
object
3 properties
BidGroupWorkPlanRotationResponse
object
4 properties 3 required
SecondaryPresence
object
2 properties 1 required
ListWrapperFixedAvailability
object
1 property
UserScheduleActivity
object
7 properties
UserScheduleFullDayTimeOffMarker
object
6 properties
BuSchedulerSettingsResponse
object
2 properties 2 required
ShiftTradeQueryAgentTradesJobResponse
object
7 properties 3 required
BuShortTermForecastListing
object
1 property
UpdateMuAgentWorkPlanFailureResponse
object
3 properties 2 required
ReceivingScheduleLookup
object
1 property 1 required
TimeOffIntegrationStatusResponseListing
object
1 property
BuSearchAgentSchedulesRequest
object
3 properties 2 required
AgentIntegrationsRequest
object
2 properties 1 required
BuScheduleReferenceForMuRoute
object
4 properties
UpdateMuAgentRequest
object
2 properties 1 required
RecurrenceEndSettings
object
2 properties
ActivityCodeReference
object
2 properties 1 required
QueryAvailabilityManagementUnitsSettingsResponse
object
1 property 1 required
BulkUpdateShiftTradeStateResult
object
1 property
AgentAddOpportunityEnrollment
object
1 property 1 required
TimeOffPlanManagementUnitAssociation
object
2 properties 1 required
UserTimeOffIntegrationStatusResponse
object
3 properties 3 required
PerformancePredictionRecalculationUploadResponse
object
4 properties
BuTimeOffLimitValueRange
object
10 properties 9 required
ShiftTradeWeekSummaryResponseItem
object
3 properties 3 required
ListWrapperScheduleSetRequest
object
1 property
RequiredLocalDateRange
object
2 properties 2 required
RoutingSkillReference
object
2 properties
AdminBulkUpdateAlternativeShiftTradeState
object
3 properties 3 required
HistoricalAdherenceExceptionInfo
object
11 properties
QueryOpportunityEnrollmentsResult
object
3 properties 1 required
UpdateAdherenceExplanationStatusRequest
object
1 property
ShiftTradeNotification
object
8 properties
WeekScheduleGenerationResult
object
4 properties
SchedulingPeriod
object
2 properties 2 required
ServiceGoalTemplateReference
object
2 properties 1 required
ActivityPlanAsaImpactOverride
object
1 property 1 required
CapacityPlanRequest
object
7 properties 6 required
CreatePlanningGroupRequest
object
3 properties 3 required
WfmHistoricalShrinkageRequest
object
4 properties 1 required
HrisTimeOffTypesResponse
object
2 properties
CapacityPlanForecastInputsResponse
object
4 properties 3 required
MinimumStaffingResponse
object
5 properties 5 required
AvailableTimeOffResponse
object
1 property
WfmHistoricalAdherenceBulkUserDayMetrics
object
11 properties
QueryOpportunityEnrollmentsRequest
object
2 properties
UpdateCapacityPlanRequest
object
8 properties 1 required
CreateManagementUnitApiRequest
object
6 properties 2 required
CreateTimeOffPlanBusinessUnitAssociation
object
2 properties
HistoricalDataJobEntityStatus
object
3 properties
WfmServiceGoalImpact
object
2 properties 2 required
BulkUpdateShiftTradeStateResponse
object
3 properties
ListWrapperAlternativeShiftBuSettingsGranularity
object
1 property
WorkPlanBidMetadata
object
4 properties 2 required
AgentQueryOpportunitiesResponse
object
2 properties
LongTermRequirementsResponse
object
4 properties 1 required
CreateManagementUnitSettingsRequest
object
5 properties
NotificationsResponse
object
1 property
WfmHistoricalAdherenceResponse
object
5 properties
AgentIntegrationsResponse
object
4 properties 2 required
ValidateAgentUnavailableTimesRequest
object
2 properties 2 required
TimeOffLimitListing
object
1 property
ScheduleBidListResponse
object
1 property
BuTimeOffLimitResponse
object
5 properties 2 required
ScheduleSetRequest
object
2 properties 1 required
WfmHistoricalAdherenceBulkUserResult
object
7 properties
DeletableUserReference
object
3 properties
RecurrenceSettings
object
3 properties 3 required
MonthlyPlanningPeriodSettings
object
1 property 1 required
AdminAgentWorkPlanPreferenceResponse
object
4 properties 3 required
AlternativeShiftSearchOffersRequest
object
4 properties 3 required
BuCurrentAgentScheduleSearchResponse
object
6 properties
ShiftTradeListResponse
object
1 property
OpportunitiesResultWithPagination
object
2 properties 1 required
WfmUserNotification
object
11 properties 3 required
MoveAgentResponse
object
2 properties
WfmIntegrationReference
object
2 properties
UserListScheduleRequestBody
object
4 properties 3 required
ValueWrapperPlanningPeriodSettings
object
1 property
CalendarUrlResponse
object
2 properties
UserScheduleAdherence
object
24 properties
AgentAssignedScheduleSetList
object
1 property 1 required
IntradayPerformancePredictionData
object
3 properties
BuCreateBlankScheduleRequest
object
3 properties 2 required
ManagementUnitReference
object
2 properties
BuTimeOffPlanResponse
object
16 properties 8 required
AgentScheduleBiddingPreferencePriority
object
2 properties 1 required
ShiftTradeShiftResponseItem
object
4 properties 4 required
SchedulerMessageTypeSeverity
object
2 properties
ForecastInputPlanningGroupData
object
2 properties 2 required
AvailableTimeOffRequest
object
2 properties 1 required
CapacityPlanMetadata
object
5 properties 3 required
TimeOffPlan
object
10 properties 1 required
BuScheduleNotificationsSettingsResponse
object
2 properties 2 required
AddShiftTradeJobRequest
object
4 properties 1 required
WfmHistoricalShrinkageTeamsRequest
object
4 properties 2 required
PerformancePredictionRecalculationResponse
object
4 properties 2 required
DailyPossibleShift
object
6 properties
BidGroupWorkPlanRotationRequest
object
2 properties 2 required
BuRescheduleAgentScheduleResult
object
3 properties
CapacityPlanningPlanningGroupAllocation
object
5 properties 5 required
BusinessUnitActivityCodeListing
object
2 properties
UserTimeOffRequestReference
object
3 properties 1 required
SchedulerMessageArgument
object
2 properties
CreateAdminTimeOffRequest
object
12 properties 3 required
SchedulerMessageSeverityCount
object
2 properties
PerformancePredictionUploadSchema
object
2 properties 2 required
WorkPlanPatternRequest
object
1 property 1 required
LanguageReference
object
2 properties
MuAgentQueueTimeRequest
object
2 properties 2 required
BuActivitySettingsResponse
object
1 property
UpdateWorkPlanRotationAgentRequest
object
4 properties 1 required
AlternativeShiftJobReference
object
4 properties 2 required
CopyWorkPlan
object
1 property 1 required
AvailabilityRange
object
2 properties 2 required
QueryEffectiveScheduleSetsRequest
object
2 properties 2 required
SearchUnmatchedShiftTradeListJobRequest
object
4 properties 3 required
QueryExternalActivityOpportunitiesResponse
object
1 property 1 required
CopyWorkPlanRotationRequest
object
1 property 1 required
TimeOffSettingsRequest
object
5 properties
BuNotificationSettingsRequest
object
1 property
TimeOffPlanBusinessUnitAssociation
object
2 properties
BuAgentScheduleRescheduleResponse
object
5 properties
BuAgentScheduleUpdate
object
2 properties
QueryPlanningGroupToStaffingGroupsRequest
object
2 properties
ForecastPlanningGroupsResponse
object
2 properties
PerformancePredictionOutputs
object
3 properties 3 required
BuAgentScheduleHistoryChangeMetadata
object
2 properties
ServiceGoalTemplate
object
8 properties 1 required
ShiftTradeMatchesSummaryResponse
object
1 property
ActivityCodeContainer
object
2 properties 1 required
ShiftTradeMatchViolation
object
2 properties
UpdateAgentScheduleBiddingPreference
object
2 properties 2 required
WorkPlanConstraintMessage
object
2 properties
BidGroupWorkPlanResponse
object
6 properties
ActivityPlanStructureWithOccurrenceSessionsUsersReference
object
3 properties 2 required
UnavailableTimesValidationResult
object
3 properties 2 required
WorkPlanConstraintsViolationMessage
object
2 properties 2 required
ServiceGoalTemplateList
object
2 properties
HistoricalImportStatusJobResponse
object
3 properties
BuCreateTimeOffLimitRequest
object
2 properties
PlanningGroupReference
object
2 properties 1 required
EvaluateShiftTradeListJobRequest
object
2 properties 2 required
PlanningGroupList
object
2 properties
ActivityPlanListItem
object
17 properties 11 required
AgentScheduleBidScheduleSetResponse
object
2 properties 1 required
BuFullDayTimeOffMarker
object
11 properties
StaffingGroupAllocation
object
14 properties 4 required
UpdateShiftTradeJobRequest
object
5 properties 2 required
ShiftTradeSearchUnmatchedTradesBuJobResponse
object
7 properties 3 required
BuShortTermForecastingSettings
object
1 property
BuActivitySettingsRequest
object
1 property
ShiftTradeMatchReviewUserResponse
object
5 properties
WfmHistoricalAdherenceResultWrapper
object
3 properties
BuUserListing
object
1 property 1 required
RoutePathResponse
object
4 properties
PlanningGroupMinimumsRequest
object
2 properties 2 required
AgentQueueTimeRequest
object
4 properties 3 required
WorkPlanBidListResponse
object
1 property
UpdateMuAgentWorkPlansBatchResponse
object
1 property 1 required
WeekScheduleListItemResponse
object
8 properties 1 required
UserReference
object
2 properties
AdherenceExplanationJob
object
9 properties
ValueWrapperBuShortTermForecastReference
object
1 property
CapacityPlanForecastInputsTemplate
object
5 properties 4 required
SearchShiftTradesRequest
object
2 properties 1 required
ListWrapperAlternativeShiftBuSettingsActivityCategory
object
1 property
ListWrapperOverrideDate
object
1 property
ScheduleUploadProcessingResponse
object
3 properties
BulkUpdateOpportunityEnrollmentsStatusResponse
object
2 properties 2 required
WorkPlanBidGroupResponse
object
4 properties 1 required
BuManagementUnitScheduleSummary
object
5 properties
BuGenerateScheduleRequest
object
4 properties 2 required
BuGetCurrentAgentScheduleRequest
object
2 properties 2 required
BusinessUnitResponse
object
5 properties
HistoricalImportStatusListing
object
2 properties
UpdateNotificationsResponse
object
1 property
HistoricalAdherenceQueryResult
object
11 properties
BuListAlternativeShiftTradesResponse
object
2 properties
BuSchedulingSettingsResponse
object
7 properties 2 required
BuSchedulerSettingsRequest
object
2 properties 1 required
QueryAgentScheduleUnavailableTimesResponse
object
2 properties 2 required
ShiftStartVariance
object
2 properties 2 required
BulkOpportunitiesRequest
object
1 property 1 required
QueryTimeOffIntegrationStatusRequest
object
1 property 1 required
WorkPlanConstraintViolationMessage
object
2 properties 2 required
AlternativeShiftNotification
object
9 properties 4 required
HistoricalImportStatus
object
11 properties
BuAgentScheduleHistoryDroppedChange
object
4 properties
TimeOffBalanceJobResponse
object
2 properties
AgentScheduleUnavailableTime
object
2 properties 1 required
ShiftTradeMatchResponseItem
object
2 properties 2 required
IgnoredActivityCategories
object
1 property
SourcePlanningGroupRequest
object
2 properties 2 required
WfmHistoricalAdherenceBulkResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-workforce-management-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Workforce Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.