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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Journey API

Predictive Engagement, Customer Journey

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 92 operations across 61 paths, and defines 249 schemas. It is described by OpenAPI 2.0, at version v2.

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

92 operations 61 paths 249 schemas 10 DELETE49 GET7 PATCH21 POST5 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
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Journey 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 92

Across 61 paths, the API surfaces 92 operations — 10 DELETE, 49 GET, 7 PATCH, 21 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Journey 92

Predictive Engagement, Customer Journey

POST
/api/v2/analytics/journeys/aggregates/query
Query for journey aggregates
postAnalyticsJourneysAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/journeys/aggregates/jobs
Query for journey aggregates asynchronously
postAnalyticsJourneysAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/journeys/aggregates/jobs/{jobId}
Get status for async query for journey aggregates
getAnalyticsJourneysAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/journeys/aggregates/jobs/{jobId}
Delete/cancel an async request for journey aggregates
deleteAnalyticsJourneysAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsJourneysAggregatesJobResults 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/journey/segments
Retrieve segment assignments by external contact ID.
getExternalcontactsContactJourneySegments 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/{contactId}/journey/segments
Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned…
postExternalcontactsContactJourneySegments 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/journey/sessions
Retrieve all sessions for a given external contact.
getExternalcontactsContactJourneySessions 4 params → 200400401403404408409413
GET
/api/v2/journey/actionmaps/{actionMapId}
Retrieve a single action map.
getJourneyActionmap 1 param → 200400401403404408409413
DELETE
/api/v2/journey/actionmaps/{actionMapId}
Delete single action map.
deleteJourneyActionmap 1 param → 204400401403404408409413
PATCH
/api/v2/journey/actionmaps/{actionMapId}
Update single action map.
patchJourneyActionmap 2 params → 200400401403404408409413
GET
/api/v2/journey/actionmaps
Retrieve all action maps.
getJourneyActionmaps 8 params → 200400401403404408409413
POST
/api/v2/journey/actionmaps
Create an action map.
postJourneyActionmaps 1 param → 200201400401403404408409
GET
/api/v2/journey/actiontargets/{actionTargetId}deprecated
Deprecated. Retrieve a single action target.
getJourneyActiontarget 1 param → 200400401403404408409413
PATCH
/api/v2/journey/actiontargets/{actionTargetId}deprecated
Deprecated. Update a single action target.
patchJourneyActiontarget 2 params → 200400401403404408409413
GET
/api/v2/journey/actiontargetsdeprecated
Deprecated. Retrieve all action targets.
getJourneyActiontargets 2 params → 200400401403404408409413
GET
/api/v2/journey/actiontemplates/{actionTemplateId}
Retrieve a single action template.
getJourneyActiontemplate 1 param → 200400401403404408409413
DELETE
/api/v2/journey/actiontemplates/{actionTemplateId}
Delete a single action template.
deleteJourneyActiontemplate 2 params → 204400401403404408409413
PATCH
/api/v2/journey/actiontemplates/{actionTemplateId}
Update a single action template.
patchJourneyActiontemplate 2 params → 200400401403404408409413
GET
/api/v2/journey/actiontemplates
Retrieve all action templates.
getJourneyActiontemplates 7 params → 200400401403404408409413
POST
/api/v2/journey/actiontemplates
Create a single action template.
postJourneyActiontemplates 1 param → 200201400401403404408409
GET
/api/v2/journey/actionmaps/estimates/jobs/{jobId}deprecated
Deprecated. Get status of job.
getJourneyActionmapsEstimatesJob 1 param → 200202400401403404408409
GET
/api/v2/journey/actionmaps/estimates/jobs/{jobId}/resultsdeprecated
Deprecated. Get estimates from completed job.
getJourneyActionmapsEstimatesJobResults 1 param → 200400401403404408409413
POST
/api/v2/journey/actionmaps/estimates/jobsdeprecated
Deprecated. Query for estimates
postJourneyActionmapsEstimatesJobs 1 param → 202400401403404408409413
GET
/api/v2/journey/sessions/{sessionId}/events
Retrieve all events for a given session.
getJourneySessionEvents 4 params → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}
Get a core type from which all schemas are built
getJourneyExternaleventsSchemasCoretype 1 param → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas/coretypes
Get the list of core types enabled for a specific namespace.
getJourneyExternaleventsSchemasCoretypes → 200400401403404408409413
GET
/api/v2/journey/externalevents/configurations/{configId}
Get an external events configuration
getJourneyExternaleventsConfiguration 1 param → 200400401403404408409413
DELETE
/api/v2/journey/externalevents/configurations/{configId}
Delete an external events configuration.
deleteJourneyExternaleventsConfiguration 1 param → 204400401403404408409413
PATCH
/api/v2/journey/externalevents/configurations/{configId}
Update an external events configuration.
patchJourneyExternaleventsConfiguration 2 params → 200400401403404408409413
GET
/api/v2/journey/externalevents/configurations
Get all external event configurations.
getJourneyExternaleventsConfigurations 2 params → 200400401403404408409413
POST
/api/v2/journey/externalevents/configurations
Create an external events configuration.
postJourneyExternaleventsConfigurations 1 param → 200400401403404408409413
POST
/api/v2/journey/externalevents/configurations/{configurationId}/events
Create external events
postJourneyExternaleventsConfigurationEvents 2 params → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas/limits
Get quantitative limits on schemas
getJourneyExternaleventsSchemasLimits → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas/{schemaId}
Get a schema
getJourneyExternaleventsSchema 1 param → 200400401403404408409413
PUT
/api/v2/journey/externalevents/schemas/{schemaId}
Update a schema
putJourneyExternaleventsSchema 2 params → 200400401403404408409413
DELETE
/api/v2/journey/externalevents/schemas/{schemaId}
Delete a schema
deleteJourneyExternaleventsSchema 1 param → 204400401403404408409413
GET
/api/v2/journey/externalevents/schemas/{schemaId}/versions
Get all versions of a External Events schema
getJourneyExternaleventsSchemaVersions 1 param → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}
Get a specific version of a schema
getJourneyExternaleventsSchemaVersion 2 params → 200400401403404408409413
GET
/api/v2/journey/externalevents/schemas
Get a list of schemas.
getJourneyExternaleventsSchemas → 200400401403404408409413
POST
/api/v2/journey/externalevents/schemas
Create a schema
postJourneyExternaleventsSchemas 1 param → 200400401403404408409413
POST
/api/v2/journey/flows/paths/query
Query for flow paths.
postJourneyFlowsPathsQuery 1 param → 200400401403404408409413
GET
/api/v2/journey/outcomes/{outcomeId}deprecated
Deprecated. Retrieve a single outcome.
getJourneyOutcome 1 param → 200400401403404408409413
DELETE
/api/v2/journey/outcomes/{outcomeId}deprecated
Deprecated. Delete an outcome.
deleteJourneyOutcome 1 param → 204400401403404408409413
PATCH
/api/v2/journey/outcomes/{outcomeId}deprecated
Deprecated. Update an outcome.
patchJourneyOutcome 2 params → 200400401403404408409413
GET
/api/v2/journey/outcomesdeprecated
Deprecated. Retrieve all outcomes.
getJourneyOutcomes 6 params → 200400401403404408409413
POST
/api/v2/journey/outcomesdeprecated
Deprecated. Create an outcome.
postJourneyOutcomes 1 param → 200201400401403404408409
GET
/api/v2/journey/sessions/{sessionId}/outcomescoresdeprecated
Deprecated. Retrieve latest outcome score associated with a session for all outcomes.
getJourneySessionOutcomescores 1 param → 200400401403404408409413
GET
/api/v2/journey/outcomes/predictors/{predictorId}deprecated
Deprecated. Retrieve a single outcome predictor.
getJourneyOutcomesPredictor 1 param → 200400401403404408409413
DELETE
/api/v2/journey/outcomes/predictors/{predictorId}deprecated
Deprecated. Delete an outcome predictor.
deleteJourneyOutcomesPredictor 1 param → 204400401403404408409413
GET
/api/v2/journey/outcomes/predictorsdeprecated
Deprecated. Retrieve all outcome predictors.
getJourneyOutcomesPredictors → 200400401403404408409413
POST
/api/v2/journey/outcomes/predictorsdeprecated
Deprecated. Create an outcome predictor.
postJourneyOutcomesPredictors 1 param → 200201400401403404408409
GET
/api/v2/journey/segments/{segmentId}
Retrieve a single segment.
getJourneySegment 1 param → 200400401403404408409413
DELETE
/api/v2/journey/segments/{segmentId}
Delete a segment.
deleteJourneySegment 1 param → 204400401403404408409413
PATCH
/api/v2/journey/segments/{segmentId}
Update a segment.
patchJourneySegment 2 params → 200400401403404408409413
GET
/api/v2/journey/segments
Retrieve all segments.
getJourneySegments 7 params → 200400401403404408409413
POST
/api/v2/journey/segments
Create a segment.
postJourneySegments 1 param → 200201400401403404408409
GET
/api/v2/journey/sessions/{sessionId}
Retrieve a single session.
getJourneySession 1 param → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}
Get a Journey View by ID
getJourneyView 1 param → 200400401403404408409413
DELETE
/api/v2/journey/views/{viewId}
Delete a Journey View by ID
deleteJourneyView 1 param → 204400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{versionId}
Get a Journey View by ID and version
getJourneyViewVersion 2 params → 200400401403404408409413
PUT
/api/v2/journey/views/{viewId}/versions/{versionId}
Update a Journey View by ID and version
putJourneyViewVersion 3 params → 200400401403404408409413
POST
/api/v2/journey/views/{viewId}/versions
Update a Journey View by ID
postJourneyViewVersions 2 params → 200400401403404408409413
GET
/api/v2/journey/views
Get a list of Journey Views
getJourneyViews 5 params → 200400401403404408409413
POST
/api/v2/journey/views
Create a new Journey View
postJourneyViews 1 param → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}
Get a Chart by ID
getJourneyViewVersionChart 3 params → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}
Get a Chart by ID and version
getJourneyViewVersionChartVersion 4 params → 200400401403404408409413
GET
/api/v2/journey/views/data/details
Get details about the data available for journey queries including oldest and newest event dates
getJourneyViewsDataDetails → 200400401403404408409413
POST
/api/v2/journey/views/encodings/validate
Validate whether an encoding exist for a label/value combination.
postJourneyViewsEncodingsValidate 1 param → 200400401403404408409413
GET
/api/v2/journey/views/eventdefinitions/{eventDefinitionId}
Get an Event Definition
getJourneyViewsEventdefinition 1 param → 200400401403404408409413
PUT
/api/v2/journey/views/eventdefinitions/{eventDefinitionId}
Update external event for journey views
putJourneyViewsEventdefinition 2 params → 200400401403404408409413
GET
/api/v2/journey/views/eventdefinitions
Get a list of Event Definitions
getJourneyViewsEventdefinitions → 200400401403404408409413
PUT
/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate
Activate external event for journey views
putJourneyViewsEventdefinitionActivate 2 params → 200400401403404408409413
GET
/api/v2/journey/views/eventdefinitions/external/changes
Get changes in external event definitions
getJourneyViewsEventdefinitionsExternalChanges → 200400401403404408409413
GET
/api/v2/journey/views/eventdefinitions/external
Get external events for journey views
getJourneyViewsEventdefinitionsExternal → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest
Get the latest job of a journey view version.
getJourneyViewVersionJobsLatest 2 params → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}
Get the job for a journey view version.
getJourneyViewVersionJob 3 params → 200400401403404408409413
PATCH
/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}
Update the job for a journey view version. Only the status can be changed and only to Cancelled
patchJourneyViewVersionJob 4 params → 200400401403404408409413
GET
/api/v2/journey/views/jobs/me
Get my jobs
getJourneyViewsJobsMe 4 params → 200400401403404408409413
GET
/api/v2/journey/views/jobs
Get the jobs for an organization.
getJourneyViewsJobs 4 params → 200400401403404408409413
POST
/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs
Submit a job request for a journey view version.
postJourneyViewVersionJobs 2 params → 202400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}
Get the chart result associated with a journey view job.
getJourneyViewVersionJobResultsChart 4 params → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results
Get the result of a job for a journey view version.
getJourneyViewVersionJobResults 3 params → 200400401403404408409413
GET
/api/v2/journey/views/schedules
Get the journey schedules for an organization.
getJourneyViewsSchedules 2 params → 200400401403404408409413
GET
/api/v2/journey/views/{viewId}/schedules
Get the Schedule for a JourneyView
getJourneyViewSchedules 1 param → 200400401403404408409413
POST
/api/v2/journey/views/{viewId}/schedules
Add a new Schedule to a JourneyView
postJourneyViewSchedules 2 params → 200201400401403404408409
PUT
/api/v2/journey/views/{viewId}/schedules
Update the Schedule for a JourneyView
putJourneyViewSchedules 2 params → 200400401403404408409413
DELETE
/api/v2/journey/views/{viewId}/schedules
Delete the Schedule of a JourneyView
deleteJourneyViewSchedules 1 param → 200204400401403404408409
POST
/api/v2/journey/deployments/{deploymentId}/actionevent
Sends an action event, which is used for changing the state of actions that have been offered to the user.
postJourneyDeploymentActionevent 2 params → 204400401403404408409413
POST
/api/v2/journey/deployments/{deploymentId}/appevents
Send a journey app event, used for tracking customer activity on an application.
postJourneyDeploymentAppevents 2 params → 200400401403404408409413
GET
/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping
Send a ping.
getJourneyDeploymentCustomerPing 7 params → 200400401403404408409413
POST
/api/v2/journey/deployments/{deploymentId}/webevents
Send a journey web event, used for tracking customer activity on a website.
postJourneyDeploymentWebevents 2 params → 200400401403404408409413

Schemas 249

The contract defines 249 schemas that model the data the API accepts and returns. The most detailed are Session (51 properties), ActionMap (20 properties), PatchActionMap (20 properties), WebEventResponse (18 properties). Each schema is shown below with its type and property counts.

SegmentAssignmentSegment
object
2 properties 1 required
OutcomeQuantileCondition
object
3 properties 2 required
ExternalEventIdentifiers
object
1 property 1 required
JourneyEventDefinition
object
An event definition used when creating journey views
8 properties 4 required
ExternalEvent
object
4 properties 4 required
AddressableEntityRef
object
2 properties
UnprocessedSegmentAssignments
object
3 properties 1 required
JsonSchemaDocument
object
A JSON Schema document.
8 properties
JourneyViewSchedule
object
5 properties 3 required
ActionEventRequest
object
7 properties 3 required
SegmentAssignment
object
5 properties 4 required
AsyncQueryStatus
object
5 properties
PatchCloseButtonStyleProperties
object
2 properties
CustomEventAttribute
object
2 properties 2 required
StatisticalResponse
object
3 properties
JourneyViewResult
object
A journey view result
2 properties
ActionMapAction
object
8 properties
AggregateViewData
object
2 properties
PatchActionTarget
object
5 properties
JourneyViewLink
object
A link between elements in a journey view
5 properties 1 required
JourneyViewElementFilter
object
A set of filters on an element within a journey view
3 properties 1 required
EventSession
object
3 properties 2 required
EventListing
object
4 properties
StatisticalSummary
object
14 properties
PatchSurveyQuestion
object
5 properties 1 required
SdkLibrary
object
2 properties 2 required
FlowPathsFlowDetails
object
4 properties 4 required
JourneyViewLinkTimeConstraint
object
2 properties
CoretypeListing
object
3 properties
SegmentAssignmentEvent
object
1 property 1 required
ExternalEventChange
object
A change in an external event definition
7 properties
OutcomeScore
object
7 properties
DataRange
object
2 properties
OutcomeAchievedEventOutcome
object
4 properties 3 required
Referrer
object
9 properties 5 required
AppEvent
object
13 properties 6 required
MaxLength
object
2 properties 2 required
OutcomePredictorRequest
object
1 property 1 required
WebEventResponseSession
object
7 properties 4 required
OutcomeAchievedEvent
object
10 properties 1 required
JourneyViewElementFilterNumberPredicate
object
A numeric filter on an element within a journey view
4 properties 2 required
OutcomePredictorListing
object
1 property
WebEventBrowser
object
3 properties 2 required
RequestEntityTypeCriteria
object
5 properties 3 required
JourneyViewScheduleListing
object
10 properties
ConversationUserDisposition
object
3 properties 2 required
UpdateSegmentAssignmentRequest
object
2 properties
TextStyleProperties
object
4 properties
JourneyViewUser
object
3 properties
AsyncQueryResponse
object
1 property
JourneyPattern
object
5 properties 4 required
EntityListing
object
1 property
ActionTemplate
object
10 properties 3 required
WebActionEvent
object
14 properties 6 required
JourneyAggregateQueryPredicate
object
5 properties
JourneyViewElementAttributes
object
Attributes on an element in a journey view
3 properties 1 required
PatchExternalSegment
object
1 property
PatchCriteria
object
4 properties
ExternalEventSummary
object
Summary of an external event definition
9 properties
RequestMapping
object
4 properties
AssignedSegment
object
2 properties 1 required
ExternalEventsResponse
object
1 property 1 required
ConnectedQueue
object
2 properties
OutcomeProbabilityCondition
object
3 properties 2 required
ActionMapActionTemplate
object
2 properties
CallToAction
object
3 properties 1 required
ExternalSegment
object
3 properties 3 required
ActionMapEstimateOutcomeCriteria
object
5 properties 1 required
KeyValue
object
2 properties 2 required
RequestPage
object
4 properties 2 required
RequestJourneyPattern
object
5 properties 4 required
JourneyExternalEventsSchema
object
7 properties
PatchTextStyleProperties
object
4 properties
PatchActionTemplate
object
6 properties 1 required
EventAction
object
5 properties 5 required
JourneyAggregationView
object
4 properties 3 required
JourneyViewResultMetrics
object
The metrics of an element or a link in journey
5 properties
WebMessagingOfferProperties
object
1 property
JourneySurveyQuestion
object
5 properties 1 required
Event
object
12 properties 5 required
OutcomePercentileCondition
object
3 properties 2 required
PatchCtaButtonStyleProperties
object
5 properties
SegmentListing
object
10 properties
SegmentForUnassignment
object
1 property 1 required
ContentOffer
object
9 properties 2 required
JourneyExternalEventsSchemaListing
object
3 properties
AppEventResponseSession
object
7 properties 5 required
NumericRange
object
4 properties
JourneyAggregateQueryResponse
object
1 property
PatchJourney
object
1 property
MinLength
object
2 properties 2 required
SegmentUnassignments
object
1 property 1 required
UpdateExternalEventRequest
object
Request to update an external event
2 properties 2 required
PatchContentOfferStyleProperties
object
3 properties
SessionLastEvent
object
3 properties 3 required
UpdateSegmentAssignmentResponse
object
1 property 1 required
WebMessagingOfferFields
object
2 properties
ExternalEventsRequest
object
1 property 1 required
ContentOfferStyleProperties
object
3 properties
RequestDevice
object
10 properties 4 required
DomainEntityRef
object
3 properties
PatchAction
object
8 properties 1 required
ActivateExternalEventRequest
object
Request to activate an external event
2 properties 2 required
FlowPaths
object
4 properties 2 required
UnprocessedExternalEvent
object
5 properties 4 required
JourneyViewElement
object
An element within a journey view
6 properties 3 required
ArchitectFlowFields
object
2 properties
FlowPathsFlowFilter
object
1 property 1 required
ActionMapListing
object
10 properties
SegmentAssignments
object
1 property 1 required
ContextPattern
object
1 property 1 required
ActionSurvey
object
1 property 1 required
CustomEventAttributeList
object
2 properties 2 required
ActionMapScheduleGroups
object
2 properties 1 required
JourneySchemaUpdateRequest
object
Update an external event schema
3 properties 3 required
ActionMapEstimateRequest
object
2 properties
PatchCallToAction
object
3 properties
JourneyAsyncAggregateQueryResponse
object
2 properties
JourneyAggregateQueryClause
object
2 properties 2 required
JourneyViewElementDisplayAttributes
object
Display attributes for an element in a journey view
3 properties 3 required
RequestCriteria
object
4 properties 2 required
NetworkConnectivity
object
4 properties 3 required
OutcomeRefRequest
object
1 property 1 required
ServiceLevel
object
2 properties
JourneyAsyncAggregationQuery
object
10 properties 2 required
JourneyAggregationQuery
object
9 properties 2 required
PatchContext
object
1 property
Detail
object
4 properties
PatchActionMap
object
20 properties 3 required
SegmentEstimateCount
object
2 properties
UpdateExternalEventResponse
object
Response for updating an external event definition
5 properties
ResponsePage
object
9 properties 5 required
ActionMap
object
20 properties 1 required
OutcomeRequest
object
8 properties 1 required
ConversationChannel
object
3 properties 1 required
OutcomeScoresResult
object
2 properties
JourneyViewJobListing
object
10 properties
EstimateJobAsyncResponse
object
2 properties
JourneyAggregateDataContainer
object
2 properties
ValidationLimits
object
6 properties
JourneyViewJob
object
9 properties 7 required
JourneyViewChartMetric
object
A metric to measure within the chart
4 properties 2 required
ExternalEventsConfigurationListing
object
10 properties
AppEventResponse
object
18 properties 11 required
PatchOutcome
object
8 properties 1 required
PatchContentOfferStylingConfiguration
object
7 properties
ExternalEventChangesResponse
object
Response for getting changes in external event definitions
1 property
JourneyViewResultLink
object
Represents a link between 2 elements in a journey view result
3 properties
SegmentForAssignment
object
1 property 1 required
AchievedOutcome
object
2 properties 1 required
ExternalEventExternalId
object
2 properties 2 required
OutcomeAchievement
object
2 properties 2 required
WebEvent
object
16 properties 10 required
Device
object
10 properties 5 required
AggregateMetricData
object
3 properties
PatchContextPattern
object
1 property
GroupByAttribute
object
2 properties
PatchContentOffer
object
9 properties
Context
object
1 property 1 required
JourneyViewChartDisplayAttributes
object
Display attributes for the chart, such as type, labels and legends
4 properties
OpenActionProperties
object
2 properties
Criteria
object
4 properties 4 required
ContentOfferStylingConfiguration
object
7 properties
Browser
object
11 properties 6 required
JourneyViewChartMetricResultValue
object
2 properties
OutcomeRef
object
2 properties
PatchActionSurvey
object
1 property 1 required
ActionEventActionMap
object
4 properties 3 required
JourneyAggregateQueryFilter
object
3 properties 1 required
CreateExternalEventsConfigurationRequest
object
5 properties 5 required
PatchEntityTypeCriteria
object
5 properties
CloseButtonStyleProperties
object
2 properties
JourneyViewChart
object
A chart within the context of the elements of the the journey view
10 properties 1 required
PatchContentPositionProperties
object
4 properties
RequestContextPattern
object
1 property 1 required
JourneyViewElementFilterPredicate
object
A filter on an element within a journey view
4 properties 2 required
Limit
object
3 properties
WebEventRequest
object
13 properties 4 required
ActionTargetListing
object
10 properties
JourneyCaseAssociation
object
The representation of a case association on a journey session.
5 properties 1 required
JourneyPage
object
10 properties 5 required
JourneyGeolocation
object
10 properties
WebEventResponse
object
18 properties 12 required
JourneyJsonSchemaRequest
object
A JSON Schema for create/update requests.
5 properties 3 required
GetExternalEventsResponse
object
Response for listing external events
1 property
ActionTarget
object
11 properties
FlowPathsElement
object
7 properties 3 required
Activation
object
2 properties 1 required
JourneyView
object
A journey view
13 properties 1 required
PatchActionProperties
object
5 properties
SessionListing
object
4 properties
JourneySegment
object
15 properties 11 required
EntityTypeCriteria
object
5 properties 5 required
Items
object
2 properties
SchemaQuantityLimits
object
16 properties
ActivateExternalEventResponse
object
Response for activation of an external event
5 properties
Journey
object
1 property 1 required
JourneyViewChartResult
object
4 properties
ActionMapEstimateResult
object
4 properties
Coretype
object
11 properties
FlowPathsQuery
object
2 properties 2 required
PatchAssociatedValueField
object
2 properties
SessionSegmentAssignment
object
2 properties 2 required
UrlCondition
object
2 properties 2 required
ActionTemplateListing
object
10 properties
ErrorBody
object
11 properties
ContentPositionProperties
object
4 properties
WebEventDevice
object
9 properties 4 required
ActionMapScheduleGroup
object
1 property 1 required
ActionProperties
object
5 properties
OpenActionFields
object
2 properties 1 required
SegmentAssignmentSession
object
3 properties 2 required
JourneyViewListing
object
10 properties
Number
object
2 properties
Outcome
object
12 properties 9 required
JourneyViewChartGroupByAttribute
object
A journey element attribute to group by within the chart
2 properties 2 required
PatchSegment
object
10 properties
DeploymentWebAction
object
10 properties 5 required
JourneyJsonSchemaDocument
object
An External Events JSON Schema
5 properties 2 required
AssociatedValueField
object
2 properties 2 required
AppEventRequest
object
13 properties 6 required
RequestExternalSegment
object
3 properties 2 required
JourneyViewResultElement
object
An element within a journey view result
4 properties
JourneyEventDefinitionListing
object
3 properties
JourneyViewElementFilterRangeData
object
2 properties
RequestContext
object
1 property
Session
object
51 properties 6 required
JourneySegmentRequest
object
10 properties 1 required
JourneyViewElementFilterRange
object
the range of attribute values to filter on. At least one comparator must be defined
6 properties
PatchJourneyPattern
object
5 properties
Label
object
3 properties 3 required
RequestJourney
object
1 property
JourneyViewChartMetricResult
object
2 properties
JourneyApp
object
4 properties 4 required
EventCondition
object
6 properties 4 required
ConnectedUser
object
2 properties
SegmentAssignmentListing
object
1 property
OutcomePredictor
object
3 properties
Schema
object
5 properties
UpdateExternalEventsConfigurationRequest
object
2 properties
PatchWebMessagingOfferFields
object
2 properties
ExternalEventsConfiguration
object
10 properties 8 required
CtaButtonStyleProperties
object
5 properties
PatchActionMapScheduleGroups
object
2 properties 1 required
DeploymentPing
object
2 properties
AggregationRange
object
2 properties
ItemValidationLimits
object
2 properties 2 required
OutcomeListing
object
10 properties
JourneyCampaign
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-journey-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Journey
← Back to G APIs
API Details
ID
genesys:genesys-journey-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-journey-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-journey-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Genesys Journey 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.