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

Case Management

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

This API exposes 39 operations across 33 paths, and defines 59 schemas. It is described by OpenAPI 2.0, at version v2.

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

39 operations 33 paths 59 schemas 3 DELETE19 GET6 PATCH9 POST2 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 Case 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 39

Across 33 paths, the API surfaces 39 operations — 3 DELETE, 19 GET, 6 PATCH, 9 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Case Management 39

Case Management

GET
/api/v2/casemanagement/cases/{caseId}/associations/{associationId}
Get a Case Association.
getCasemanagementCaseAssociation 2 params → 200400401403404408409413
POST
/api/v2/casemanagement/cases/associations/query
Query for Case associations by interaction.
postCasemanagementCasesAssociationsQuery 1 param → 200400401403404408409413
GET
/api/v2/casemanagement/cases/{caseId}/associations
Get a list of Case associations for the Case.
getCasemanagementCaseAssociations 4 params → 200400401403404408409413
POST
/api/v2/casemanagement/cases/{caseId}/associations
Create a Case association.
postCasemanagementCaseAssociations 2 params → 200201400401403404408409
POST
/api/v2/casemanagement/caseplans/query
Query for Caseplans.
postCasemanagementCaseplansQuery 1 param → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}
Get a Caseplan.
getCasemanagementCaseplan 1 param → 200400401403404408409413
DELETE
/api/v2/casemanagement/caseplans/{caseplanId}
Delete a Caseplan.
deleteCasemanagementCaseplan 1 param → 200204400401403404408409
PATCH
/api/v2/casemanagement/caseplans/{caseplanId}
Update the attributes of a Caseplan.
patchCasemanagementCaseplan 2 params → 200400401403404408409413
POST
/api/v2/casemanagement/caseplans/{caseplanId}/publish
Publish Caseplan.
postCasemanagementCaseplanPublish 1 param → 200400401403404408409413
POST
/api/v2/casemanagement/caseplans/{caseplanId}/versions
Create Caseplan version.
postCasemanagementCaseplanVersions 1 param → 200202400401403404408409
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}
Get a Caseplan version.
getCasemanagementCaseplanVersion 2 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings
Get the intake settings for a Caseplan version.
getCasemanagementCaseplanVersionIntakesettings 2 params → 200400401403404408409413
PUT
/api/v2/casemanagement/caseplans/{caseplanId}/intakesettings
Update the intake settings for a Caseplan.
putCasemanagementCaseplanIntakesettings 2 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas
Get the data schemas for a Caseplan version.
getCasemanagementCaseplanVersionDataschemas 2 params → 200400401403404408409413
POST
/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas
Add a data schema to a draft Caseplan.
postCasemanagementCaseplanDataschemas 2 params → 200201400401403404408409
PUT
/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}
Update a data schema on a draft Caseplan.
putCasemanagementCaseplanDataschema 3 params → 200400401403404408409413
DELETE
/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}
Remove a data schema from a draft Caseplan.
deleteCasemanagementCaseplanDataschema 2 params → 200204400401403404408409
GET
/api/v2/casemanagement/caseplans
Get a list of Caseplans.
getCasemanagementCaseplans 4 params → 200400401403404408409413
POST
/api/v2/casemanagement/caseplans
Create a Caseplan.
postCasemanagementCaseplans 1 param → 200201400401403404408409
GET
/api/v2/casemanagement/cases/{caseId}
Get a Case.
getCasemanagementCase 2 params → 200400401403404408409413
DELETE
/api/v2/casemanagement/cases/{caseId}
Delete a Case.
deleteCasemanagementCase 1 param → 200204400401403404408409
PATCH
/api/v2/casemanagement/cases/{caseId}/priority
Update priority of a Case.
patchCasemanagementCasePriority 2 params → 200400401403404408409413
PATCH
/api/v2/casemanagement/cases/{caseId}/datedue
Update the due date of a Case.
patchCasemanagementCaseDatedue 2 params → 200400401403404408409413
PATCH
/api/v2/casemanagement/cases/{caseId}/summary
Update summary of a Case.
patchCasemanagementCaseSummary 2 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/externalcontacts/{externalContactId}
Get a list of Cases for an External Contact.
getCasemanagementCasesExternalcontact 5 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/references/{referenceId}
Get a Case by reference.
getCasemanagementCasesReference 2 params → 200400401403404408409413
POST
/api/v2/casemanagement/cases
Create a Case.
postCasemanagementCases 1 param → 200202400401403404408409
GET
/api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}
Get a Terminate Job for a Case.
getCasemanagementCaseTerminateJob 2 params → 200400401403404408409413
POST
/api/v2/casemanagement/cases/{caseId}/terminate/jobs
Create a Terminate Job for a Case.
postCasemanagementCaseTerminateJobs 1 param → 200201400401403404408409
PATCH
/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}
Update the attributes of a Stageplan.
patchCasemanagementCaseplanStageplan 3 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}
Get a Stageplan.
getCasemanagementCaseplanVersionStageplan 4 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans
Get a list of Stageplans.
getCasemanagementCaseplanVersionStageplans 6 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/{caseId}/stages/{stageId}
Get a Stage.
getCasemanagementCaseStage 2 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/{caseId}/stages
Get a list of Stages.
getCasemanagementCaseStages 4 params → 200400401403404408409413
PATCH
/api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}
Update the attributes of a Stepplan.
patchCasemanagementCaseplanStageplanStepplan 4 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}
Get a Stepplan.
getCasemanagementCaseplanVersionStageplanStepplan 5 params → 200400401403404408409413
GET
/api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans
Get a list of Stepplans.
getCasemanagementCaseplanVersionStageplanStepplans 7 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}
Get a Step.
getCasemanagementCaseStageStep 3 params → 200400401403404408409413
GET
/api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps
Get a list of Steps.
getCasemanagementCaseStageSteps 5 params → 200400401403404408409413

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are Case (21 properties), CaseplanCreateResponse (19 properties), Caseplan (17 properties), Step (14 properties). Each schema is shown below with its type and property counts.

StepReference
object
2 properties
CaseplanQueryRequest
object
7 properties
StageplanReference
object
3 properties
Stage
object
12 properties
WorkitemReference
object
3 properties
CaseUserReference
object
4 properties
CaseAssociationQuery
object
4 properties
UserReference
object
2 properties
StarrableDivision
object
3 properties
CaseReference
object
2 properties
CaseDateDueUpdate
object
1 property 1 required
Step
object
14 properties
CaseAssociationCreate
object
2 properties
UserPresence
object
10 properties
StageplanListing
object
4 properties
ErrorBody
object
11 properties
StageReference
object
2 properties
ConversationReference
object
2 properties
CaseAssociation
object
Represents an association between a Case and an interaction.
10 properties
CaseExternalContactReference
object
4 properties
CaseplanFilter
object
3 properties 3 required
StepplanUpdate
object
4 properties
CaseAssociationQueryEntityListing
object
5 properties
CustomerIntentReference
object
3 properties
Case
object
21 properties
CaseplanDataSchemaRequest
object
1 property 1 required
IntakeSettingsListing
object
1 property
Caseplan
object
17 properties 10 required
Stageplan
object
8 properties
CaseplanDataSchema
object
2 properties 1 required
CaseListing
object
4 properties
StepListing
object
4 properties
CaseplanCreateResponse
object
19 properties 10 required
Intake
object
1 property
Empty
object
CaseplanReference
object
4 properties
TerminateJob
object
7 properties
CaseplanUpdate
object
8 properties
IntakeSettingsUpdate
object
1 property
StepplanListing
object
4 properties
CaseSummaryUpdate
object
1 property 1 required
Limit
object
3 properties
WorkitemSettingsResponse
object
1 property
Stepplan
object
11 properties
CaseplanDataSchemaListing
object
1 property
CaseplanQueryEntityListing
object
5 properties
CaseplanCreate
object
10 properties 4 required
CaseCreate
object
8 properties 2 required
CaseAssociationListing
object
4 properties
IntakeSetting
object
3 properties 3 required
CaseplanListing
object
4 properties
StageListing
object
4 properties
StepplansWorktypeReference
object
3 properties
WorkitemActivityReference
object
2 properties
PresenceDefinition
object
3 properties
CasePriorityUpdate
object
1 property 1 required
StageplanUpdate
object
2 properties
WorkitemSettings
object
1 property
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-case-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 Case 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.