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 Flows API

IVR Flows

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

7 operations 6 paths 39 schemas 1 DELETE2 GET4 POST

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 Flows 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 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Flows 7

IVR Flows

POST
/api/v2/analytics/flows/aggregates/jobs
Query for flow aggregates asynchronously
postAnalyticsFlowsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/flows/aggregates/jobs/{jobId}
Get status for async query for Flow aggregates
getAnalyticsFlowsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/flows/aggregates/jobs/{jobId}
Delete/cancel an async request for flow aggregates
deleteAnalyticsFlowsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/flows/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsFlowsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/flows/observations/query
Query for flow observations
postAnalyticsFlowsObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/flows/activity/query
Query for flow activity observations
postAnalyticsFlowsActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/flows/aggregates/query
Query for flow aggregates
postAnalyticsFlowsAggregatesQuery 1 param → 200400401403404408409413

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are FlowActivityEntityData (25 properties), ObservationValue (19 properties), StatisticalSummary (14 properties), ErrorBody (11 properties). Each schema is shown below with its type and property counts.

FlowActivityMetricValue
object
4 properties
FlowAggregateQueryClause
object
2 properties 2 required
FlowObservationDataContainer
object
2 properties
AsyncQueryStatus
object
5 properties
FlowActivityEntityData
object
25 properties 1 required
FlowActivityQueryMetric
object
2 properties 1 required
FlowAggregateQueryFilter
object
3 properties 1 required
FlowAggregationView
object
4 properties 3 required
AnalyticsScoredAgent
object
2 properties
StatisticalResponse
object
3 properties
AggregateViewData
object
2 properties
FlowObservationQueryClause
object
2 properties 2 required
FlowActivityScoredAgent
object
2 properties
FlowAggregateDataContainer
object
2 properties
ErrorBody
object
11 properties
ObservationMetricData
object
5 properties
FlowActivityQueryPredicate
object
4 properties
FlowActivityData
object
4 properties
AggregateMetricData
object
3 properties
StatisticalSummary
object
14 properties
NumericRange
object
4 properties
FlowAggregationQuery
object
9 properties 2 required
ObservationValue
object
19 properties 1 required
FlowActivityResponse
object
2 properties
FlowAsyncAggregationQuery
object
10 properties 2 required
Limit
object
3 properties
FlowActivityQuery
object
4 properties 2 required
FlowActivityQueryClause
object
2 properties 2 required
FlowAggregateQueryResponse
object
1 property
FlowObservationQueryPredicate
object
5 properties
AsyncQueryResponse
object
1 property
FlowActivityQueryFilter
object
3 properties 1 required
FlowObservationQueryResponse
object
1 property
FlowAggregateQueryPredicate
object
5 properties
AggregationRange
object
2 properties
FlowObservationQuery
object
3 properties 2 required
FlowAsyncAggregateQueryResponse
object
2 properties
FlowObservationQueryFilter
object
3 properties 1 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-flows-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
#Flows
← Back to G APIs
API Details
ID
genesys:genesys-flows-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-flows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-flows-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 Flows 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.