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

View organizational level usage data

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

11 operations 11 paths 21 schemas 6 GET5 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 Usage 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 11

Across 11 paths, the API surfaces 11 operations — 6 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Usage 11

View organizational level usage data

POST
/api/v2/oauth/clients/{clientId}/usage/query
Query for OAuth client API usage
postOauthClientUsageQuery 2 params → 200202400401403404408409
GET
/api/v2/oauth/clients/{clientId}/usage/summary
Get a summary of OAuth client API usage
getOauthClientUsageSummary 2 params → 200202400401403404408409
GET
/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}
Get the results of a usage query
getOauthClientUsageQueryResult 2 params → 200400401403404408409413
POST
/api/v2/usage/query
Query organization API Usage -
postUsageQuery 1 param → 200202400401403404408409
GET
/api/v2/usage/query/{executionId}/results
Get the results of a usage query
getUsageQueryExecutionIdResults 1 param → 200400401403404408409413
POST
/api/v2/usage/simplesearch
Search organization API Usage
postUsageSimplesearch 1 param → 200202400401403404408409
GET
/api/v2/usage/simplesearch/{executionId}/results
Get the results of a usage search. Number of records to be returned is limited to 20,000 results.
getUsageSimplesearchExecutionIdResults 3 params → 200400401403404408409413
POST
/api/v2/usage/client/{clientId}/aggregates/query/jobs
Query your client's public api usage.
postUsageClientClientIdAggregatesQueryJobs 2 params → 200202400401403404408409
GET
/api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}
Get the status and results of the usage query
getUsageClientClientIdAggregatesQueryJob 4 params → 200202400401403404408409
POST
/api/v2/usage/aggregates/query/jobs
Query your organization's public api usage.
postUsageAggregatesQueryJobs 1 param → 200202400401403404408409
GET
/api/v2/usage/aggregates/query/jobs/{jobId}
Get the status and results of the usage query
getUsageAggregatesQueryJob 3 params → 200202400401403404408409

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ApiUsageRow (13 properties), OrganizationPublicApiUsage (12 properties), ClientPublicApiUsage (11 properties), ErrorBody (11 properties). Each schema is shown below with its type and property counts.

ClientPublicApiUsage
object
11 properties
UserReference
object
2 properties
OrganizationUsageQueryResponse
object
4 properties 1 required
ApiUsageRow
object
13 properties
ClientPublicApiUsageResultsResponse
object
6 properties 1 required
OrganizationPublicApiUsage
object
12 properties
Cursors
object
2 properties
ClientUsageQueryResponse
object
4 properties 1 required
ClientPublicApiUsageQueryRequest
object
9 properties 1 required
OrganizationPublicApiUsageResultsResponse
object
6 properties 1 required
ErrorBody
object
11 properties
ApiUsageSimpleSearch
object
5 properties 1 required
ApiUsageClientQuery
object
4 properties 1 required
UsageExecutionResult
object
2 properties
ApiUsageQueryResult
object
3 properties
DomainEntityRef
object
3 properties
OrganizationPublicApiUsageQueryRequest
object
10 properties 1 required
UsageQuerySortBy
object
2 properties
Limit
object
3 properties
ApiUsageOrganizationQuery
object
4 properties 1 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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