Genesys Workforce Management API
Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration
Operations 324
Showing the first 250 of 324. The full set is in the contract, and via get_provider_operations.
GET
/api/v2/workforcemanagement/calendar/data/ics
Get ics formatted calendar based on shareable link
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes
Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitI…
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes
Create a new activity code
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Get an activity code
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Deletes an activity code
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}
Update an activity code
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups
Get intraday planning groups for the given date
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday
Get intraday data for the given date for the requested planningGroupIds
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl
Creates a signed upload URL for importing a short term forecast
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import
Starts importing the uploaded short term forecast
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults
Gets the forecast generation results
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts
Get short term forecasts
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate
Generate a short term forecast
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}
Get a short term forecast
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}
Delete a short term forecast
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups
Gets the forecast planning group snapshot
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data
Get the result of a short term forecast calculation
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement
Get the staffing requirement by planning group for a forecast
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata
Get the result of a long term forecast calculation
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy
Copy a short term forecast
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/users
Get users in the business unit
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits
Get all authorized management units in the business unit
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}
Update the requested management unit
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/move
Move the requested management unit to a new business unit
#
GET
/api/v2/workforcemanagement/managementunits/divisionviews
Get management units across divisions
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}
Get data for agent in the management unit
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades
Gets all the shift trades for a given agent
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents
Update agent configurations
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query
Get agents work plans configuration
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk
Updates agent work plan configuration
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/users
Get users in the management unit
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Get a planning group
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Deletes the planning group
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}
Updates the planning group
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups
Gets list of planning groups
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups
Adds a new planning group
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Get a service goal template
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Delete a service goal template
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}
Updates a service goal template
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates
Gets list of service goal templates
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates
Adds a new service goal template
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users
Gets list of users available for whom you can send direct shift trade requests
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched
Gets a summary of all shift trades in the matched state
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups
Gets a list of staffing groups
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups
Creates a new staffing group
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Gets a staffing group
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Deletes a staffing group
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}
Updates a staffing group
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query
Gets a list of planning group to staffing groups list association
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query
Gets staffing group associations for a list of user IDs
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search
Searches for potential shift trade matches for the current agent
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
Gets all the shift trades for a given week
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades
Adds a shift trade
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk
Updates the state of a batch of shift trades
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}
Updates a shift trade. This route can only be called by the initiating agent
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match
Matches a shift trade. This route can only be called by the receiving agent
#
GET
/api/v2/workforcemanagement/agents/{agentId}/managementunit
Get the management unit to which the agent belongs
#
GET
/api/v2/workforcemanagement/agents/me/managementunit
Get the management unit to which the currently logged in agent belongs
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate
Validate Work Plan
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Get a work plan
#
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Delete a work plan
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}
Update a work plan
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans
Create a new work plan
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy
Create a copy of work plan
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations
Get work plan rotations
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations
Create a new work plan rotation
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Get a work plan rotation
#
DELETE
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Delete a work plan rotation
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}
Update a work plan rotation
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy
Create a copy of work plan rotation
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs
Gets the latest job for all activity plans in the business unit
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans
Create an activity plan
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}
Get an activity plan
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}
Update an activity plan
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs
Run an activity plan manually
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}
Gets an activity plan run job
#
GET
/api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}
Query the status of an adherence explanation operation.
#
POST
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations
Add an adherence explanation for the requested user
#
GET
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}
Get an adherence explanation
#
PATCH
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}
Update an adherence explanation
#
POST
/api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query
Query adherence explanations for the given agent across a specified range
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query
Query adherence explanations across an entire business unit for the requested…
#
POST
/api/v2/workforcemanagement/adherence/explanations
Submit an adherence explanation for the current user
#
GET
/api/v2/workforcemanagement/adherence/explanations/{explanationId}
Get an adherence explanation for the current user
#
POST
/api/v2/workforcemanagement/adherence/explanations/query
Query adherence explanations for the current user
#
GET
/api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}
Request to fetch the status of the agent adherence job.
#
POST
/api/v2/workforcemanagement/agents/me/adherence/historical/jobs
Request an agent historical adherence report
#
POST
/api/v2/workforcemanagement/adherence/historical/bulk
Request a historical adherence report in bulk
#
GET
/api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}
Request to fetch the status of the historical adherence bulk job.
#
GET
/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}
Query the status of a historical adherence request operation.
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery
Request a historical adherence report
#
POST
/api/v2/workforcemanagement/teams/{teamId}/adherence/historical
Request a teams historical adherence report
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence
Get a list of user schedule adherence records for the requested management unit
#
GET
/api/v2/workforcemanagement/teams/{teamId}/adherence
Get a list of user schedule adherence records for the requested team
#
GET
/api/v2/workforcemanagement/adherence
Get a list of UserScheduleAdherence records for the requested users
#
POST
/api/v2/workforcemanagement/agents/me/possibleworkshifts
Get agent possible work shifts for requested time frame
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/settings/query
Query availability management units settings
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/schedules/query
Get agent schedule generation unavailable times
#
PATCH
/api/v2/workforcemanagement/managementunits/{managementUnitId}/unavailabletimes/settings
Update management unit availability settings
#
POST
/api/v2/workforcemanagement/agents/{agentId}/unavailabletimes/query
Get agent unavailable times
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings
Get alternative shifts settings for a business unit
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings
Update alternative shifts settings for a business unit
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search
List alternative shifts trades for a given management unit or agent
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}
Query the status of an alternative shift search trade operation.
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}
Get an alternative shifts trade in a business unit for a given trade ID
#
POST
/api/v2/workforcemanagement/alternativeshifts/offers/jobs
Request a list of alternative shift offers for a given schedule
#
GET
/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}
Query the status of an alternative shift offers operation.
#
POST
/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs
Request a search of alternative shift offers for a given shift
#
GET
/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}
Query the status of an alternative shift search offers operation.
#
GET
/api/v2/workforcemanagement/alternativeshifts/trades
Get a list of my alternative shifts trades
#
POST
/api/v2/workforcemanagement/alternativeshifts/trades
Create my alternative shift trade using an existing offer's jobId
#
GET
/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}
Query the status of an alternative shift trades operation.
#
GET
/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}
Get my alternative shift trade by trade ID
#
PATCH
/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}
Update my alternative shifts trade by trade ID
#
PATCH
/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs
Bulk update alternative shift trade states
#
GET
/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}
Query the status of an alternative shift trade state operation.
#
POST
/api/v2/workforcemanagement/calendar/url/ics
Create a newly generated calendar link for the current user; if the current…
#
DELETE
/api/v2/workforcemanagement/calendar/url/ics
Disable generated calendar link for the current user
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}
Get a capacity plan
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}
Update a capacity plan configuration
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans
Get list of capacity plans for a business unit
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans
Create a new capacity plan
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove
Delete capacity plans in a business unit
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations
Get a capacity plan's staffing group allocations
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations
Create staffing group allocations for a capacity plan
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements
Get a capacity plan's staffing requirements
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy
Copy a capacity plan
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate
Regenerate requirements for capacity plan
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query
Query staffing groups allocations history for a capacity plan
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory
Delete staffing group allocations history created for a capacity plan before…
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast
Get a capacity plan's forecast inputs
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}
Get the latest long term staffing requirements for a business unit
#
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
#
GET
/api/v2/workforcemanagement/schedulebids
Gets the list of schedule bids that belong to an agent.
#
GET
/api/v2/workforcemanagement/schedulebids/{bidId}/preference
Gets an agent's schedule bidding preference
#
PUT
/api/v2/workforcemanagement/schedulebids/{bidId}/preference
Update an agent's schedule set preference
#
GET
/api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets
Gets an agent's schedule sets for a bid
#
POST
/api/v2/workforcemanagement/timeofflimits/available/query
Queries available time off for the current user
#
GET
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions
Get the daily waitlist positions of a time off request for the current user
#
GET
/api/v2/workforcemanagement/timeoffrequests
Get a list of time off requests for the current user
#
GET
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
Get a time off request for the current user
#
PATCH
/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}
Update a time off request for the current user
#
POST
/api/v2/workforcemanagement/unavailabletimes/validation/jobs
Validates proposed changes to an agent's unavailable time spans against…
#
GET
/api/v2/workforcemanagement/unavailabletimes/settings
Get availability management unit's settings for agent
#
GET
/api/v2/workforcemanagement/unavailabletimes/validation/jobs/{jobId}
Query agent unavailable times validation job
#
GET
/api/v2/workforcemanagement/workplanbids/{bidId}/preferences
Gets an agent's work plan bidding preference
#
PATCH
/api/v2/workforcemanagement/workplanbids/{bidId}/preferences
Update an agent's work plan bidding preference
#
GET
/api/v2/workforcemanagement/workplanbids/{bidId}/workplans
Gets an agent's work plans for a bid
#
GET
/api/v2/workforcemanagement/workplanbids
Gets the list of work plan bids that belong to an agent
#
GET
/api/v2/workforcemanagement/alternativeshifts/settings
Get alternative shifts settings from the current logged in agent’s business unit
#
POST
/api/v2/workforcemanagement/agentschedules/managementunits/mine
Fetch agent schedules for the logged in user's management unit
#
POST
/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query
Retrieves integration statuses for a list of current user time off requests
#
POST
/api/v2/workforcemanagement/notifications/update
Mark a list of notifications as read or unread
#
GET
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}
Retrieves delete job status for historical data imports associated with the job…
#
GET
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs
Retrieves all delete job status for historical data
#
POST
/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs
Delete the list of the historical data import entries
#
GET
/api/v2/workforcemanagement/historicaldata/importstatus/{jobId}
Retrieves status of the historical data imports associated with job id
#
GET
/api/v2/workforcemanagement/historicaldata/importstatus
Retrieves status of the historical data imports of the organization
#
POST
/api/v2/workforcemanagement/historicaldata/validate
Trigger validation process for historical import
#
GET
/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}
Query the results of time off types job
#
POST
/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs
Get list of time off types configured in integration
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings
Get minimum staffing settings for a business unit
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings
Update minimum staffing settings for a business unit
#
POST
/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add
Bulk add enrollments to opportunities for the authenticated agent
#
POST
/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update
Bulk update enrollment status for the authenticated agent
#
POST
/api/v2/workforcemanagement/agents/opportunities/query
Query opportunities for the authenticated agent
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update
Bulk update enrollment status
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query
Query enrollments
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query
Query opportunities within the specified date range
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query
Query opportunities by external activity IDs
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add
Bulk add opportunities
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove
Bulk remove opportunities
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish
Bulk publish opportunities
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update
Bulk update opportunities status
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}
Get opportunity details
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}
Update the opportunity
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations
Request a daily recalculation of the performance prediction for the associated…
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}
Get recalculated performance prediction result
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions
Get the performance prediction for the associated schedule
#
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…
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary
Get summary of bid groups that belong to a schedule bid
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Get a schedule bid group
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Delete a schedule bid group by bid group Id
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}
Update a schedule bid group by bid group Id
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups
Add a bid group in a given schedule bid
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences
Get agents schedule bid preferences for a bid group
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences
Overrides the assigned schedule bid for the specified agents
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Get a schedule bid
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Delete a schedule bid
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}
Update a schedule bid
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids
Get list of schedule bids
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids
Create a new schedule bid
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy
Copy a schedule bid
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets
Fetch all the agents with effective schedule set for the given BU
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs
Get the list of scheduling runs
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Get a scheduling run
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Cancel a scheduling run
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}
Mark a schedule run as applied
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result
Get the result of a rescheduling operation
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search
Search published schedules
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}
Get the metadata for the schedule, describing which management units and agents…
#
DELETE
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}
Delete a schedule
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule
Start a rescheduling run
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl
Creates a signed upload URL for updating a schedule
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules
Get the list of week schedules for the specified week
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules
Create a blank schedule
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl
Creates a signed upload URL for importing a schedule
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import
Starts processing a schedule import
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate
Generate a schedule
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy
Copy a schedule
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults
Get the generation results for a generated schedule
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast
Get the headcount forecast by planning group for the schedule
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query
Loads agent schedule data from the schedule.
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}
Loads agent's schedule history
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update
Starts processing a schedule update
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search
Query published schedules for given given time range for set of users
#
POST
/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search
Query published schedules for given given time range for set of users
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules
Deprecated.
#
GET
/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}
Deprecated.
#
GET
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings
Get scheduler settings for a business unit
#
PATCH
/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings
Update scheduler settings for a business unit
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs
Queries shift trades in a management unit per user
#
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.
#
POST
/api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs
Queries and evaluates against shift trade configuration shift trades in a…
#
Documentation
Specifications
Other Resources
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml