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

Groups, members

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

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

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

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

14 operations 8 paths 56 schemas 2 DELETE8 GET3 POST1 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 Groups 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 14

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

Groups 14

Groups, members

GET
/api/v2/fieldconfigdeprecated
Fetch field config for an entity type
getFieldconfig 1 param → 200400401403404408409413
GET
/api/v2/groups/{groupId}/individuals
Get all individuals associated with the group
getGroupIndividuals 1 param → 200400401403404408409413
GET
/api/v2/groups/{groupId}/members
Get group members, includes individuals, owners, and dynamically included people
getGroupMembers 5 params → 200400401403404408409413
POST
/api/v2/groups/{groupId}/members
Add members
postGroupMembers 2 params → 202409400401403404408413
DELETE
/api/v2/groups/{groupId}/members
Remove members
deleteGroupMembers 2 params → 202400401403404408409413
GET
/api/v2/groups/{groupId}/profiledeprecated
Get group profile
getGroupProfile 2 params → 200400401403404408409413
GET
/api/v2/profiles/groupsdeprecated
Get group profile listing
getProfilesGroups 5 params → 200400401403404408409413
GET
/api/v2/groups/{groupId}
Get group
getGroup 1 param → 200400401403404408409413
PUT
/api/v2/groups/{groupId}
Update group
putGroup 2 params → 200409400401403404408413
DELETE
/api/v2/groups/{groupId}
Delete group
deleteGroup 1 param → default400401403404408409413
GET
/api/v2/groups
Get a group list
getGroups 5 params → 200400401403404408409413
POST
/api/v2/groups
Create a group
postGroups 1 param → 200400401403404408409413
GET
/api/v2/groups/search
Search groups using the q64 value returned from a previous search
getGroupsSearch 2 params → 200400401403404408409413
POST
/api/v2/groups/search
Search groups
postGroupsSearch 1 param → 200400401403404408409413

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are User (39 properties), Group (17 properties), GroupCreate (17 properties), LocationDefinition (16 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
UserConversationSummary
object
8 properties
GroupProfileEntityListing
object
10 properties
Image
object
2 properties
AddressableEntityRef
object
2 properties
User
object
39 properties 1 required
WorkPlanBidRanks
object
4 properties
Education
object
5 properties
MediaSummaryDetail
object
2 properties
GroupMembersUpdate
object
2 properties 1 required
GroupSearchCriteria
object
9 properties 1 required
Biography
object
5 properties
UserAuthorization
object
4 properties
ResourcePermissionPolicy
object
11 properties
WritableDivision
object
3 properties
GroupsSearchResponse
object
9 properties 6 required
OutOfOffice
object
8 properties
UserPresence
object
10 properties
LocationEmergencyNumber
object
3 properties
UserEntityListing
object
10 properties
ErrorBody
object
11 properties
UserStations
object
4 properties
LocationImage
object
2 properties
Division
object
3 properties
GroupEntityListing
object
10 properties
ResourceConditionNode
object
5 properties
OAuthLastTokenIssued
object
1 property
EmployerInfo
object
4 properties
GroupProfile
object
6 properties 1 required
PresenceDefinition
object
3 properties
GroupSearchRequest
object
6 properties
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
LocationAddress
object
7 properties
RoutingStatus
object
3 properties
UserStation
object
8 properties
ResourceConditionValue
object
2 properties
FieldConfig
object
8 properties
Group
object
17 properties 4 required
Location
object
5 properties
Geolocation
object
11 properties
Empty
object
GroupUpdate
object
14 properties 1 required
Limit
object
3 properties
GroupCreate
object
17 properties 4 required
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
FieldList
object
10 properties
Section
object
4 properties
DomainRole
object
2 properties
Chat
object
1 property
SearchSort
object
2 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
GroupContact
object
5 properties 3 required
Contact
object
7 properties
LocationDefinition
object
16 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-groups-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 Groups 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.