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

Organization

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

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

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

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

19 operations 14 paths 26 schemas 13 GET2 PATCH4 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 Organization 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 19

Across 14 paths, the API surfaces 19 operations — 13 GET, 2 PATCH, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Organization 19

Organization

GET
/api/v2/organizations/embeddedintegrationdeprecated
Get the list of domains that will be allowed to embed PureCloud applications
getOrganizationsEmbeddedintegration → 200400401403404408409413
PUT
/api/v2/organizations/embeddedintegrationdeprecated
Update the list of domains that will be allowed to embed PureCloud applications
putOrganizationsEmbeddedintegration 1 param → 200400401403404408409413
GET
/api/v2/organizations/ipaddressauthenticationdeprecated
Get organization IP address whitelist settings
getOrganizationsIpaddressauthentication → 200400401403404408409413
PUT
/api/v2/organizations/ipaddressauthenticationdeprecated
Update organization IP address whitelist settings
putOrganizationsIpaddressauthentication 1 param → 200400401403404408409413
GET
/api/v2/organizations/whitelistdeprecated
This route is deprecated, please use /api/v2/organizations/authentication/settings instead
getOrganizationsWhitelist → 200400401403404408409413
PUT
/api/v2/organizations/whitelistdeprecated
This route is deprecated, please use /api/v2/organizations/authentication/settings instead
putOrganizationsWhitelist 1 param → 200400401403404408409413
GET
/api/v2/organizations/authentication/settings
Gets the organization's settings
getOrganizationsAuthenticationSettings → 200400401403404408409413
PATCH
/api/v2/organizations/authentication/settings
Update the organization's settings
patchOrganizationsAuthenticationSettings 1 param → 200400401403404408409413
GET
/api/v2/fieldconfigdeprecated
Fetch field config for an entity type
getFieldconfig 1 param → 200400401403404408409413
PATCH
/api/v2/organizations/features/{featureName}
Update organization
patchOrganizationsFeature 2 params → 200400401403404408409413
GET
/api/v2/organizations/me
Get organization.
getOrganizationsMe → 200400401403404408409413
PUT
/api/v2/organizations/me
Update organization.
putOrganizationsMe 1 param → 200409400401403404408413
GET
/api/v2/organizations/limits/changerequests/{requestId}
Get a limit change request
getOrganizationsLimitsChangerequest 1 param → 200400401403404408409413
GET
/api/v2/organizations/limits/changerequests
Get the available limit change requests
getOrganizationsLimitsChangerequests 5 params → 200400401403404408409413
GET
/api/v2/organizations/limits/docs
Get limit documentation
getOrganizationsLimitsDocs → 200400401403404408409413
GET
/api/v2/organizations/limits/docs/freetrial
Get free trial limit documentation
getOrganizationsLimitsDocsFreetrial → 200400401403404408409413
GET
/api/v2/organizations/limits/namespaces
Get the available limit namespaces
getOrganizationsLimitsNamespaces 2 params → 200400401403404408409413
GET
/api/v2/organizations/limits/namespaces/{namespaceName}
Get the effective limits in a namespace for an organization
getOrganizationsLimitsNamespace 1 param → 200400401403404408409413
GET
/api/v2/organizations/limits/namespaces/{namespaceName}/defaults
Get the default limits in a namespace for an organization
getOrganizationsLimitsNamespaceDefaults 1 param → 200400401403404408409413

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Organization (15 properties), LimitChangeRequestDetails (14 properties), OrganizationFeatures (13 properties), ErrorBody (11 properties). Each schema is shown below with its type and property counts.

Organization
object
15 properties 1 required
PasswordRequirements
object
8 properties
ErrorBody
object
11 properties
FreeTrialNamespace
object
3 properties
NamespaceDocs
object
3 properties
OrgWhitelistSettings
object
2 properties
LimitDocs
object
6 properties
FieldConfig
object
8 properties
EmbeddedIntegration
object
2 properties
LimitChangeRequestDetails
object
14 properties 5 required
IpAddressAuthentication
object
1 property
LimitsEntityListing
object
1 property
ApprovalNamespace
object
3 properties
StatusChange
object
6 properties
FeatureState
object
1 property
Limit
object
3 properties
FreeTrialLimit
object
4 properties
LimitChangeRequestsEntityListing
object
4 properties
FieldList
object
10 properties
PagedNamespaceListing
object
FreeTrialLimitDocs
object
1 property
LimitDocumentation
object
2 properties
Section
object
4 properties
OrgAuthSettings
object
7 properties
OrganizationFeatures
object
13 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-organization-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 Organization 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.