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

Physical locations

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

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

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

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

8 operations 4 paths 16 schemas 1 DELETE4 GET1 PATCH2 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Locations 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 8

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

Locations 8

Physical locations

GET
/api/v2/locations/{locationId}
Get Location by ID.
getLocation 2 params → 200400401403404408409413
DELETE
/api/v2/locations/{locationId}
Delete a location
deleteLocation 1 param → 204400401403404408409413
PATCH
/api/v2/locations/{locationId}
Update a location
patchLocation 2 params → 200400401403404408409413
GET
/api/v2/locations/{locationId}/sublocations
Get sublocations for location ID.
getLocationSublocations 1 param → 200400401403404408409413
GET
/api/v2/locations
Get a list of all locations.
getLocations 4 params → 200400401403404408409413
POST
/api/v2/locations
Create a location
postLocations 1 param → 200400401403404408409413
GET
/api/v2/locations/search
Search locations using the q64 value returned from a previous search
getLocationsSearch 2 params → 200400401403404408409413
POST
/api/v2/locations/search
Search locations
postLocationsSearch 1 param → 200400401403404408409413

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are LocationDefinition (16 properties), ErrorBody (11 properties), LocationEntityListing (10 properties), LocationSearchCriteria (9 properties). Each schema is shown below with its type and property counts.

LocationsSearchResponse
object
9 properties 6 required
LocationCreateDefinition
object
8 properties 1 required
AddressableEntityRef
object
2 properties
LocationImage
object
2 properties
ErrorBody
object
11 properties
LocationUpdateDefinition
object
8 properties 2 required
SearchSort
object
2 properties
LocationSearchRequest
object
7 properties
LocationAddressVerificationDetails
object
4 properties
LocationSearchCriteria
object
9 properties 1 required
LocationAddress
object
7 properties
LocationDefinition
object
16 properties
LocationEntityListing
object
10 properties
LocationEmergencyNumber
object
3 properties
Limit
object
3 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-locations-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 Locations 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.