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 Task Management API

Task Management

Genesys Task 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 Task Management. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 76 operations across 50 paths, and defines 132 schemas. It is described by OpenAPI 2.0, at version v2.

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

76 operations 50 paths 132 schemas 10 DELETE36 GET12 PATCH17 POST1 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 Task 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 76

Across 50 paths, the API surfaces 76 operations — 10 DELETE, 36 GET, 12 PATCH, 17 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Task Management 76

Task Management

GET
/api/v2/taskmanagement/workitems/bulk/jobs/users/me
Get bulk jobs created by the currently logged in user.
getTaskmanagementWorkitemsBulkJobsUsersMe 4 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}
Get the bulk add job associated with the job id.
getTaskmanagementWorkitemsBulkAddJob 1 param → 200400401403404408409413
DELETE
/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}
Delete a bulk add job
deleteTaskmanagementWorkitemsBulkAddJob 1 param → 204400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}
Update workitem bulk add job.
patchTaskmanagementWorkitemsBulkAddJob 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results
Get bulk add job results.
getTaskmanagementWorkitemsBulkAddJobResults 1 param → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/bulk/add/jobs
Create a workitem bulk add job.
postTaskmanagementWorkitemsBulkAddJobs 1 param → 200201400401403404408409
GET
/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results
Get bulk terminate job results.
getTaskmanagementWorkitemsBulkTerminateJobResults 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}
Get the bulk job associated with the job id.
getTaskmanagementWorkitemsBulkTerminateJob 1 param → 200400401403404408409413
DELETE
/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}
Delete a Bulk job
deleteTaskmanagementWorkitemsBulkTerminateJob 1 param → 204400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}
Update workitem bulk terminate job.
patchTaskmanagementWorkitemsBulkTerminateJob 2 params → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/bulk/terminate/jobs
Create a workitem bulk terminate job.
postTaskmanagementWorkitemsBulkTerminateJobs 1 param → 200201400401403404408409
POST
/api/v2/taskmanagement/workbins/query
Query for workbins
postTaskmanagementWorkbinsQuery 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workbins/{workbinId}
Get a workbin
getTaskmanagementWorkbin 1 param → 200400401403404408409413
DELETE
/api/v2/taskmanagement/workbins/{workbinId}
Delete a workbin
deleteTaskmanagementWorkbin 1 param → 204400401403404408409413
PATCH
/api/v2/taskmanagement/workbins/{workbinId}
Update the attributes of a workbin
patchTaskmanagementWorkbin 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workbins/{workbinId}/versions
Get all versions of a workbin
getTaskmanagementWorkbinVersions 4 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}
Get a version of a workbin
getTaskmanagementWorkbinVersion 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workbins/{workbinId}/history
Get a listing of a workbin's attribute change history
getTaskmanagementWorkbinHistory 4 params → 200400401403404408409413
POST
/api/v2/taskmanagement/workbins
Create a workbin
postTaskmanagementWorkbins 1 param → 201400401403404408409413
POST
/api/v2/taskmanagement/workitems
Create a workitem
postTaskmanagementWorkitems 1 param → 200201400401403404408409
POST
/api/v2/taskmanagement/workitems/query
Query for workitems
postTaskmanagementWorkitemsQuery 1 param → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/query/jobs
Create a workitem query job
postTaskmanagementWorkitemsQueryJobs 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/query/jobs/{jobId}
Get the workitem query job associated with the job id.
getTaskmanagementWorkitemsQueryJob 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/query/jobs/{jobId}/results
Get results from for workitem query job
getTaskmanagementWorkitemsQueryJobResults 1 param → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/{workitemId}/disconnect
Disconnect the assignee of the workitem
postTaskmanagementWorkitemDisconnect 1 param → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/{workitemId}/terminate
Terminate a workitem
postTaskmanagementWorkitemTerminate 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}
Get a workitem
getTaskmanagementWorkitem 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/workitems/{workitemId}
Delete a workitem
deleteTaskmanagementWorkitem 1 param → 204400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/{workitemId}
Update the attributes of a workitem
patchTaskmanagementWorkitem 2 params → 200400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/{workitemId}/assignment
Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
patchTaskmanagementWorkitemAssignment 2 params → 202400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}/versions
Get all versions of a workitem
getTaskmanagementWorkitemVersions 4 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}
Get a version of a workitem
getTaskmanagementWorkitemVersion 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}/history
Get a listing of a workitem's attribute change history
getTaskmanagementWorkitemHistory 4 params → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/{workitemId}/acd/cancel
Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
postTaskmanagementWorkitemAcdCancel 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}
Get a specific named core type.
getTaskmanagementWorkitemsSchemasCoretype 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/coretypes
Get the core types from which all schemas are built.
getTaskmanagementWorkitemsSchemasCoretypes → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/limits
Get quantitative limits on schemas
getTaskmanagementWorkitemsSchemasLimits → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/{schemaId}
Get a schema
getTaskmanagementWorkitemsSchema 1 param → 200400401403404408409413
PUT
/api/v2/taskmanagement/workitems/schemas/{schemaId}
Update a schema
putTaskmanagementWorkitemsSchema 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/workitems/schemas/{schemaId}
Delete a schema
deleteTaskmanagementWorkitemsSchema 1 param → 204400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}
Get a specific version of a schema
getTaskmanagementWorkitemsSchemaVersion 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas/{schemaId}/versions
Get all versions of a schema
getTaskmanagementWorkitemsSchemaVersions 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/schemas
Get a list of schemas.
getTaskmanagementWorkitemsSchemas → 200400401403404408409413
POST
/api/v2/taskmanagement/workitems/schemas
Create a schema
postTaskmanagementWorkitemsSchemas 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups
Get all wrapup codes added for the given user for a workitem.
getTaskmanagementWorkitemUserWrapups 6 params → 200400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups
Add/Remove a wrapup code for a given user in a workitem.
patchTaskmanagementWorkitemUserWrapups 3 params → 204400401403404408409413
PATCH
/api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups
Add/Remove a wrapup code for the current user in a workitem.
patchTaskmanagementWorkitemUsersMeWrapups 2 params → 204400401403404408409413
GET
/api/v2/taskmanagement/workitems/{workitemId}/wrapups
Get all wrapup codes added for all users for a workitem.
getTaskmanagementWorkitemWrapups 5 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}
Get a status
getTaskmanagementWorktypeStatus 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}
Delete a status
deleteTaskmanagementWorktypeStatus 2 params → 204400401403404408409413
PATCH
/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}
Update the attributes of a status
patchTaskmanagementWorktypeStatus 3 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/statuses
Get list of statuses for this worktype.
getTaskmanagementWorktypeStatuses 1 param → 200400401403404408409413
POST
/api/v2/taskmanagement/worktypes/{worktypeId}/statuses
Add a status to a worktype
postTaskmanagementWorktypeStatuses 2 params → 200201400401403404408409
POST
/api/v2/taskmanagement/worktypes/query
Query for worktypes
postTaskmanagementWorktypesQuery 1 param → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}
Get a worktype
getTaskmanagementWorktype 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/worktypes/{worktypeId}
Delete a worktype
deleteTaskmanagementWorktype 1 param → 204400401403404408409413
PATCH
/api/v2/taskmanagement/worktypes/{worktypeId}
Update the attributes of a worktype
patchTaskmanagementWorktype 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/versions
Get all versions of a worktype
getTaskmanagementWorktypeVersions 4 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}
Get a version of a worktype
getTaskmanagementWorktypeVersion 2 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/history
Get a listing of a worktype's attribute change history
getTaskmanagementWorktypeHistory 5 params → 200400401403404408409413
POST
/api/v2/taskmanagement/worktypes
Create a worktype
postTaskmanagementWorktypes 1 param → 200201400401403404408409
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}
Get a date based rule
getTaskmanagementWorktypeFlowsDatebasedRule 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}
Delete a date based rule
deleteTaskmanagementWorktypeFlowsDatebasedRule 2 params → 204400401403404408409413
PATCH
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}
Update the attributes of a date based rule
patchTaskmanagementWorktypeFlowsDatebasedRule 3 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules
Get all date based rules for a worktype
getTaskmanagementWorktypeFlowsDatebasedRules 3 params → 200400401403404408409413
POST
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules
Add a date based rule to a worktype
postTaskmanagementWorktypeFlowsDatebasedRules 2 params → 200201400401403404408409
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}
Get an attribute change rule
getTaskmanagementWorktypeFlowsOnattributechangeRule 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}
Delete a rule
deleteTaskmanagementWorktypeFlowsOnattributechangeRule 2 params → 204400401403404408409413
PATCH
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}
Update the attributes of a rule
patchTaskmanagementWorktypeFlowsOnattributechangeRule 3 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules
Get all attribute-change rules for a worktype
getTaskmanagementWorktypeFlowsOnattributechangeRules 3 params → 200400401403404408409413
POST
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules
Add an attribute-change rule to a worktype
postTaskmanagementWorktypeFlowsOnattributechangeRules 2 params → 200201400401403404408409
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}
Get an on-create rule
getTaskmanagementWorktypeFlowsOncreateRule 2 params → 200400401403404408409413
DELETE
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}
Delete a rule
deleteTaskmanagementWorktypeFlowsOncreateRule 2 params → 204400401403404408409413
PATCH
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}
Update the attributes of a rule
patchTaskmanagementWorktypeFlowsOncreateRule 3 params → 200400401403404408409413
GET
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules
Get all on-create rules for a worktype
getTaskmanagementWorktypeFlowsOncreateRules 3 params → 200400401403404408409413
POST
/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules
Add an on-create rule to a worktype
postTaskmanagementWorktypeFlowsOncreateRules 2 params → 200201400401403404408409

Schemas 132

The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are WorkitemVersion (38 properties), Workitem (37 properties), WorkitemDelta (31 properties), WorktypeVersion (27 properties). Each schema is shown below with its type and property counts.

JsonSchemaDocument
object
A JSON Schema document.
8 properties
WorkitemsChangeWorkbinDelta
object
3 properties
WorkitemDateBasedRuleCreate
object
2 properties 2 required
WorktypeCreate
object
20 properties 2 required
Worktype
object
26 properties
Workitem
object
37 properties
WorktypeQuerySort
object
2 properties
WorkitemScoredAgentDelta
object
2 properties
WorkitemWrapupEntityListing
object
4 properties
WorkbinQueryEntityListing
object
6 properties
WorkbinQueryRequest
object
6 properties 1 required
BulkJobTerminateResultsResponse
object
3 properties
WorkitemsAttributeChangeListWorkitemScoredAgentDelta
object
2 properties
CoretypeListing
object
3 properties
WorkitemQueryJobQueryFiltersCriteria
object
2 properties 1 required
ItemValidationLimits
object
2 properties 2 required
WorktypeReference
object
3 properties
BulkJobTerminateResultEntity
object
2 properties
MaxLength
object
2 properties 2 required
WorkitemQueryJobFilter
object
3 properties 3 required
WorkitemQueryJobSort
object
2 properties
WorkbinCreate
object
3 properties 1 required
WorkitemWrapup
object
5 properties
Workbin
object
8 properties
WorkitemFlowReference
object
3 properties
RoutingSkillReference
object
2 properties
BulkJobTerminateResult
object
2 properties
WorkitemVersionListing
object
5 properties
BulkJobTerminateRequest
object
1 property 1 required
WorkitemsAttributeChangeMap
object
2 properties
WrapupDelta
object
3 properties
DataSchemaListing
object
3 properties
WorkitemStatus
object
11 properties
WorkitemPagedEntityListing
object
5 properties
WorkitemsAttributeChangeInstant
object
2 properties
WorkitemPostQueryEntityListing
object
6 properties
WorkitemQueueReference
object
3 properties
WorkitemReference
object
3 properties
WorkitemCommonCreate
object
19 properties 2 required
WorkitemDateBasedRule
object
7 properties
WorkbinReference
object
3 properties
WorkitemOnAttributeChangeRuleCreate
object
2 properties 2 required
WorkbinQuerySort
object
2 properties
WorkitemUpdate
object
24 properties
WorkitemFilter
object
4 properties 4 required
WorktypeVersionListing
object
5 properties
WorkitemSchema
object
4 properties 1 required
WorkitemDelta
object
31 properties
MinLength
object
2 properties 2 required
WorkitemStatusCreate
object
8 properties 2 required
WorkitemQueryJobQueryFiltersPredicate
object
3 properties 2 required
WorkitemDateBasedConditionUpdate
object
2 properties
WorkitemOnAttributeChangeRuleListing
object
5 properties
DomainEntityRef
object
3 properties
WorkitemStatusListing
object
3 properties
TaskManagementErrorDetails
object
2 properties
WorkitemStatusUpdate
object
7 properties
WrapupIdReference
object
3 properties
WorkitemScriptReference
object
3 properties
BulkJobAddWorkitemSummary
object
5 properties
WorkbinVersionListing
object
5 properties
WorkitemVersion
object
38 properties
WorktypeQueryEntityListing
object
6 properties
WorkitemQueryJobError
object
2 properties
WorkitemRuleAction
object
1 property
WorkitemOnCreateRuleCreate
object
1 property 1 required
BulkJobAddResult
object
2 properties
WorkbinDelta
object
4 properties
WorkitemsAttributeChangeWrapupDelta
object
2 properties
Detail
object
4 properties
BulkJobAddResponse
object
3 properties
DataSchema
object
9 properties 2 required
LanguageReference
object
2 properties
WorkitemStatusReference
object
3 properties
WorkitemQueryJobCreate
object
9 properties 1 required
WorkitemDateBasedCondition
object
2 properties 2 required
WorkitemQueryJobQueryFilters
object
3 properties 2 required
ValidationLimits
object
6 properties
WorkitemQueryJobResponse
object
6 properties
WorkitemManualAssign
object
1 property 1 required
WorkitemsChangeWorkitemDelta
object
3 properties
WorktypeDelta
object
23 properties
WorkitemRuleSettings
object
1 property
WorkitemsAttributeChangeWorkitemStatusCategory
object
2 properties
WorkitemOnAttributeChangeConditionUpdate
object
3 properties 2 required
WorkitemScoredAgentRequest
object
2 properties
WorkitemQueryPostRequest
object
7 properties 1 required
WorkitemsAttributeChangeList
object
2 properties
WorkitemQuerySort
object
2 properties
BulkJob
object
10 properties
WorktypeChangeListing
object
5 properties
Limit
object
3 properties
WorkitemOnCreateRule
object
6 properties
WorkbinChangeListing
object
5 properties
AutoStatusTransitionDetail
object
3 properties
BulkJobError
object
2 properties
Items
object
2 properties
WorkitemOnCreateRuleListing
object
5 properties
WorkitemCreate
object
23 properties 2 required
SchemaQuantityLimits
object
16 properties
Coretype
object
11 properties
WorkitemsAttributeChangeString
object
2 properties
WorkitemWrapupUpdate
object
2 properties 2 required
WorkitemOnCreateRuleUpdate
object
1 property
UserReference
object
2 properties
UserReferenceWithName
object
3 properties
BulkJobAddRequest
object
1 property 1 required
WorkitemsAttributeChangeBoolean
object
2 properties
ErrorBody
object
11 properties
Division
object
3 properties
WorkitemChangeListing
object
5 properties
WorktypeVersion
object
27 properties
BulkJobUpdate
object
1 property 1 required
WorkitemTerminate
object
1 property
WorkitemDateBasedRuleListing
object
5 properties
BulkJobsListing
object
5 properties
WorkitemOnAttributeChangeCondition
object
3 properties 2 required
WorkbinVersion
object
9 properties
ExternalContactReference
object
4 properties
WorkitemsAttributeChangeInteger
object
2 properties
BulkJobEntity
object
1 property
WorkitemsAttributeChangeWorkitemRuleSettings
object
2 properties
WorkitemOnAttributeChangeRuleUpdate
object
2 properties
Schema
object
5 properties
WorkbinUpdate
object
2 properties
WorktypeQueryRequest
object
7 properties 1 required
WorkitemsChangeWorktypeDelta
object
3 properties
WorkitemDateBasedRuleUpdate
object
2 properties
WorkitemScoredAgent
object
2 properties
WorkitemOnAttributeChangeRule
object
7 properties
WorkitemUtilizationLabelReference
object
2 properties
WorktypeUpdate
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-task-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 Task 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.