Genesys

Genesys Journey API

Predictive Engagement, Customer Journey

GitHub OpenAPI

Operations 92

POST /api/v2/analytics/journeys/aggregates/query Query for journey aggregates #
POST /api/v2/analytics/journeys/aggregates/jobs Query for journey aggregates asynchronously #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId} Get status for async query for journey aggregates #
DELETE /api/v2/analytics/journeys/aggregates/jobs/{jobId} Delete/cancel an async request for journey aggregates #
GET /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
GET /api/v2/externalcontacts/contacts/{contactId}/journey/segments Retrieve segment assignments by external contact ID #
POST /api/v2/externalcontacts/contacts/{contactId}/journey/segments Assign/Unassign up to 10 segments to/from an external contact or, if a segment… #
GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions Retrieve all sessions for a given external contact #
GET /api/v2/journey/actionmaps/{actionMapId} Retrieve a single action map #
DELETE /api/v2/journey/actionmaps/{actionMapId} Delete single action map #
PATCH /api/v2/journey/actionmaps/{actionMapId} Update single action map #
GET /api/v2/journey/actionmaps Retrieve all action maps #
POST /api/v2/journey/actionmaps Create an action map #
GET /api/v2/journey/actiontargets/{actionTargetId} Deprecated. Retrieve a single action target #
PATCH /api/v2/journey/actiontargets/{actionTargetId} Deprecated. Update a single action target #
GET /api/v2/journey/actiontargets Deprecated. Retrieve all action targets #
GET /api/v2/journey/actiontemplates/{actionTemplateId} Retrieve a single action template #
DELETE /api/v2/journey/actiontemplates/{actionTemplateId} Delete a single action template #
PATCH /api/v2/journey/actiontemplates/{actionTemplateId} Update a single action template #
GET /api/v2/journey/actiontemplates Retrieve all action templates #
POST /api/v2/journey/actiontemplates Create a single action template #
GET /api/v2/journey/actionmaps/estimates/jobs/{jobId} Deprecated. Get status of job #
GET /api/v2/journey/actionmaps/estimates/jobs/{jobId}/results Deprecated. Get estimates from completed job #
POST /api/v2/journey/actionmaps/estimates/jobs Deprecated. Query for estimates #
GET /api/v2/journey/sessions/{sessionId}/events Retrieve all events for a given session #
GET /api/v2/journey/externalevents/schemas/coretypes/{coreTypeName} Get a core type from which all schemas are built #
GET /api/v2/journey/externalevents/schemas/coretypes Get the list of core types enabled for a specific namespace #
GET /api/v2/journey/externalevents/configurations/{configId} Get an external events configuration #
DELETE /api/v2/journey/externalevents/configurations/{configId} Delete an external events configuration #
PATCH /api/v2/journey/externalevents/configurations/{configId} Update an external events configuration #
GET /api/v2/journey/externalevents/configurations Get all external event configurations #
POST /api/v2/journey/externalevents/configurations Create an external events configuration #
POST /api/v2/journey/externalevents/configurations/{configurationId}/events Create external events #
GET /api/v2/journey/externalevents/schemas/limits Get quantitative limits on schemas #
GET /api/v2/journey/externalevents/schemas/{schemaId} Get a schema #
PUT /api/v2/journey/externalevents/schemas/{schemaId} Update a schema #
DELETE /api/v2/journey/externalevents/schemas/{schemaId} Delete a schema #
GET /api/v2/journey/externalevents/schemas/{schemaId}/versions Get all versions of a External Events schema #
GET /api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId} Get a specific version of a schema #
GET /api/v2/journey/externalevents/schemas Get a list of schemas #
POST /api/v2/journey/externalevents/schemas Create a schema #
POST /api/v2/journey/flows/paths/query Query for flow paths #
GET /api/v2/journey/outcomes/{outcomeId} Deprecated. Retrieve a single outcome #
DELETE /api/v2/journey/outcomes/{outcomeId} Deprecated. Delete an outcome #
PATCH /api/v2/journey/outcomes/{outcomeId} Deprecated. Update an outcome #
GET /api/v2/journey/outcomes Deprecated. Retrieve all outcomes #
POST /api/v2/journey/outcomes Deprecated. Create an outcome #
GET /api/v2/journey/sessions/{sessionId}/outcomescores Deprecated. #
GET /api/v2/journey/outcomes/predictors/{predictorId} Deprecated. Retrieve a single outcome predictor #
DELETE /api/v2/journey/outcomes/predictors/{predictorId} Deprecated. Delete an outcome predictor #
GET /api/v2/journey/outcomes/predictors Deprecated. Retrieve all outcome predictors #
POST /api/v2/journey/outcomes/predictors Deprecated. Create an outcome predictor #
GET /api/v2/journey/segments/{segmentId} Retrieve a single segment #
DELETE /api/v2/journey/segments/{segmentId} Delete a segment #
PATCH /api/v2/journey/segments/{segmentId} Update a segment #
GET /api/v2/journey/segments Retrieve all segments #
POST /api/v2/journey/segments Create a segment #
GET /api/v2/journey/sessions/{sessionId} Retrieve a single session #
GET /api/v2/journey/views/{viewId} Get a Journey View by ID #
DELETE /api/v2/journey/views/{viewId} Delete a Journey View by ID #
GET /api/v2/journey/views/{viewId}/versions/{versionId} Get a Journey View by ID and version #
PUT /api/v2/journey/views/{viewId}/versions/{versionId} Update a Journey View by ID and version #
POST /api/v2/journey/views/{viewId}/versions Update a Journey View by ID #
GET /api/v2/journey/views Get a list of Journey Views #
POST /api/v2/journey/views Create a new Journey View #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId} Get a Chart by ID #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion} Get a Chart by ID and version #
GET /api/v2/journey/views/data/details Get details about the data available for journey queries including oldest and… #
POST /api/v2/journey/views/encodings/validate Validate whether an encoding exist for a label/value combination #
GET /api/v2/journey/views/eventdefinitions/{eventDefinitionId} Get an Event Definition #
PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId} Update external event for journey views #
GET /api/v2/journey/views/eventdefinitions Get a list of Event Definitions #
PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate Activate external event for journey views #
GET /api/v2/journey/views/eventdefinitions/external/changes Get changes in external event definitions #
GET /api/v2/journey/views/eventdefinitions/external Get external events for journey views #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest Get the latest job of a journey view version #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} Get the job for a journey view version #
PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} Update the job for a journey view version. #
GET /api/v2/journey/views/jobs/me Get my jobs #
GET /api/v2/journey/views/jobs Get the jobs for an organization #
POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs Submit a job request for a journey view version #
GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId} Get the chart result associated with a journey view job #
GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results Get the result of a job for a journey view version #
GET /api/v2/journey/views/schedules Get the journey schedules for an organization #
GET /api/v2/journey/views/{viewId}/schedules Get the Schedule for a JourneyView #
POST /api/v2/journey/views/{viewId}/schedules Add a new Schedule to a JourneyView #
PUT /api/v2/journey/views/{viewId}/schedules Update the Schedule for a JourneyView #
DELETE /api/v2/journey/views/{viewId}/schedules Delete the Schedule of a JourneyView #
POST /api/v2/journey/deployments/{deploymentId}/actionevent Sends an action event, which is used for changing the state of actions that… #
POST /api/v2/journey/deployments/{deploymentId}/appevents Send a journey app event, used for tracking customer activity on an application #
GET /api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping Send a ping #
POST /api/v2/journey/deployments/{deploymentId}/webevents Send a journey web event, used for tracking customer activity on a website #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-journey-api-openapi.yml

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-journey-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-journey-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Journey API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (891 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-journey-api-openapi.yml