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

Search aggregate, users, groups

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

23 operations 14 paths 216 schemas 9 GET14 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 Search 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 23

Across 14 paths, the API surfaces 23 operations — 9 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

Search 23

Search aggregate, users, groups

POST
/api/v2/conversations/participants/attributes/search
Search conversations
postConversationsParticipantsAttributesSearch 1 param → 200400401403404408409413
POST
/api/v2/conversations/customattributes/search
Search resources.
postConversationsCustomattributesSearch 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
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
GET
/api/v2/documentation/search
Search documentation using the q64 value returned from a previous search
getDocumentationSearch 1 param → 200400401403404408409413
POST
/api/v2/documentation/search
Search documentation
postDocumentationSearch 1 param → 200400401403404408409413
GET
/api/v2/documentation/gkn/search
Search gkn documentation using the q64 value returned from a previous search
getDocumentationGknSearch 1 param → 200400401403404408409413
POST
/api/v2/documentation/gkn/search
Search gkn documentation
postDocumentationGknSearch 1 param → 200400401403404408409413
GET
/api/v2/search
Search using the q64 value returned from a previous search.
getSearch 3 params → 200400401403404408409413
POST
/api/v2/search
Search resources.
postSearch 2 params → 200400401403404408409413
GET
/api/v2/search/suggest
Suggest resources using the q64 value returned from a previous suggest query.
getSearchSuggest 3 params → 200400401403404408409413
POST
/api/v2/search/suggest
Suggest resources.
postSearchSuggest 2 params → 200400401403404408409413
POST
/api/v2/speechandtextanalytics/transcripts/search
Search resources.
postSpeechandtextanalyticsTranscriptsSearch 1 param → 200400401403404408409413
POST
/api/v2/teams/search
Search resources.
postTeamsSearch 1 param → 200400401403404408409413
GET
/api/v2/telephony/providers/edges/sites/search
Search sites using the q64 value returned from a previous search
getTelephonyProvidersEdgesSitesSearch 2 params → 200400401403404408409413
POST
/api/v2/telephony/providers/edges/sites/search
Search sites
postTelephonyProvidersEdgesSitesSearch 1 param → 200400401403404408409413
GET
/api/v2/users/search
Search users using the q64 value returned from a previous search
getUsersSearch 3 params → 200400401403404408409413
POST
/api/v2/users/search
Search users
postUsersSearch 1 param → 200400401403404408409413
POST
/api/v2/users/search/teams/assign
Search users assigned to teams
postUsersSearchTeamsAssign 1 param → 200400401403404408409413
GET
/api/v2/voicemail/search
Search voicemails using the q64 value returned from a previous search
getVoicemailSearch 2 params → 200400401403404408409413
POST
/api/v2/voicemail/search
Search voicemails
postVoicemailSearch 1 param → 200400401403404408409413

Schemas 216

The contract defines 216 schemas that model the data the API accepts and returns. The most detailed are Participant (50 properties), Evaluation (43 properties), Edge (43 properties), Queue (41 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
SearchAggregation
object
6 properties
ResourcePermissionPolicy
object
11 properties
AiScoring
object
3 properties
WritableDivision
object
3 properties
SiteConnection
object
11 properties
FaxStatus
object
8 properties
VoicemailsSearchResponse
object
9 properties 6 required
ScreenMonitoring
object
12 properties
Conversation
object
17 properties 2 required
AdjustableLiveSpeakerDetection
object
6 properties
UserStations
object
4 properties
TeamSearchRequest
object
6 properties 1 required
SitesSearchResponse
object
9 properties 6 required
Script
object
15 properties
GKNDocumentationSearchCriteria
object
9 properties 1 required
OAuthLastTokenIssued
object
1 property
Wrapup
object
7 properties
ConversationMessageMetadataContent
object
Metadata information about a message content.
2 properties
Disposition
object
7 properties 1 required
QuestionSettings
object
2 properties
Queue
object
41 properties
ConditionalGroupActivationPilotRule
object
2 properties
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
AcwSettings
object
2 properties
Screenshare
object
16 properties
ExpansionCriterium
object
2 properties
DirectRoutingMediaSettings
object
1 property
DomainEntityListingEvaluationForm
object
10 properties
NTPSettings
object
1 property
Geolocation
object
11 properties
AiScoringSettings
object
3 properties
SuggestSearchCriteria
object
8 properties
TeamSearchCriteria
object
9 properties 1 required
UserSearchRequest
object
9 properties
SiteSearchCriteria
object
9 properties 1 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
ConditionalGroupActivationCondition
object
3 properties
Page
object
8 properties
VoicemailMessage
object
21 properties
EvaluationReference
object
2 properties
EdgeAutoUpdateConfig
object
4 properties 4 required
TopicDuration
object
1 property
DispositionSilentCallTimeout
object
3 properties
GKNDocumentationResult
object
4 properties 1 required
UserSearchCriteria
object
9 properties 1 required
ConversationParticipantSearchCriteria
object
9 properties 1 required
PagelessDomainEntityListingEvaluationVersion
object
3 properties
Site
object
31 properties 2 required
EdgeConnectionInfo
object
7 properties
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
DomainEdgeSoftwareUpdateDto
object
10 properties 1 required
VoicemailCopyRecord
object
3 properties
InternalMessageDetails
object
2 properties
Biography
object
5 properties
LocationSearchCriteria
object
9 properties 1 required
GroupsSearchResponse
object
9 properties 6 required
EmailMediaSettings
object
5 properties
Email
object
27 properties
Participant
object
50 properties
ConversationDivisionMembership
object
2 properties
AnswerOption
object
6 properties
ResourceConditionNode
object
5 properties
ConditionalGroupActivation
object
2 properties
EvaluationQuestion
object
14 properties
EvaluationQuestionGroupScore
object
16 properties
JourneyAction
object
2 properties 2 required
TeamsSearchResponse
object
9 properties 6 required
LocationsSearchResponse
object
9 properties 6 required
DispositionParameters
object
1 property
MessageSubtypeSettings
object
2 properties
ArrayNode
object
ConversationParticipantSearchRequest
object
6 properties
EmailAddress
object
2 properties
DomainEntityRef
object
3 properties
EvaluationQuestionScore
object
10 properties
EvaluationVersion
object
3 properties
AiAnswer
object
3 properties
TranscriptSearchRequest
object
8 properties 1 required
TransferResponseModifiedBy
object
2 properties
EvaluationSettingsAssignee
object
2 properties
QueueMessagingAddresses
object
3 properties
InactivityTimeoutSettings
object
3 properties
DomainRole
object
2 properties
Calibration
object
16 properties
JourneyCustomer
object
2 properties 2 required
SearchSort
object
2 properties
ServiceLevel
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
PresenceDefinition
object
3 properties
Signature
object
4 properties
ConversationRoutingData
object
8 properties
MemberGroup
object
6 properties
ConnectedEdge
object
6 properties
Detail
object
4 properties
RecordersState
object
4 properties
EdgeInterface
object
8 properties
DomainEdgeSoftwareVersionDto
object
8 properties
SearchRequest
object
10 properties 1 required
UserAuthorization
object
4 properties
EvaluationScoringSet
object
11 properties
QuestionGroupSettings
object
2 properties
VoicemailSearchRequest
object
7 properties
Address
object
5 properties
DefaultAnswersTo
object
4 properties
GKNDocumentationSearchRequest
object
6 properties
ConversationCustomAttributesSearchRequest
object
6 properties
OutOfOffice
object
8 properties
JsonSearchResponse
object
7 properties 6 required
UserPresence
object
10 properties
ScoredAgent
object
2 properties
LocationEmergencyNumber
object
3 properties
DirectRouting
object
6 properties
AiScoringSetting
object
1 property
MessageDetails
object
10 properties
Call
object
35 properties
Cobrowsesession
object
19 properties
EmployerInfo
object
4 properties
SkillsToRemove
object
3 properties
ConversationChat
object
22 properties
Edge
object
43 properties 1 required
SiteSearchRequest
object
7 properties
VoicemailSearchCriteria
object
9 properties 1 required
Attachment
object
6 properties
RoutingStatus
object
3 properties
GKNDocumentationSearchResponse
object
9 properties 6 required
RoutingRule
object
3 properties
ResourceConditionValue
object
2 properties
PhoneNumberColumn
object
3 properties
UsersSearchResponse
object
9 properties 6 required
InboundRoute
object
19 properties 2 required
LocationSearchRequest
object
7 properties
Voicemail
object
2 properties
Limit
object
3 properties
CallbackMediaSettings
object
18 properties
TransferDestination
object
2 properties
DocumentationResult
object
20 properties 1 required
ConversationMessageMetadata
object
Metadata information about a message.
3 properties
SuggestSearchRequest
object
3 properties 2 required
DialerPreview
object
6 properties
InternalMessage
object
15 properties
Chat
object
1 property
GroupContact
object
5 properties 3 required
EvaluationQuestionGroup
object
12 properties
JourneyContext
object
3 properties 1 required
Contact
object
7 properties
LocationDefinition
object
16 properties
QueueEmailAddress
object
2 properties
JsonCursorSearchResponse
object
4 properties 2 required
AfterCallWork
object
3 properties
AgentOwnedRouting
object
3 properties
UserConversationSummary
object
8 properties
Actions
object
1 property
Image
object
2 properties
TranscriptTopic
object
9 properties
Education
object
5 properties
ConversationQueueMediaSettings
object
4 properties
EvaluationForm
object
12 properties 2 required
GroupSearchCriteria
object
9 properties 1 required
ConditionalGroupRoutingRule
object
6 properties
TransferInitiator
object
1 property
DocumentationSearchCriteria
object
9 properties 1 required
Callback
object
29 properties
DispositionAmdTimeout
object
4 properties
MessageMedia
object
5 properties
UserReferenceWithName
object
3 properties
DivisionEntityRef
object
4 properties
AssistanceCondition
object
2 properties
TranscriptSearchCriteria
object
9 properties
SearchCriteria
object
9 properties
Bullseye
object
1 property
DisconnectReason
object
4 properties
TrunkBaseAssignment
object
2 properties
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
VisibilityCondition
object
2 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
TopicOffset
object
2 properties
ConversationReference
object
2 properties
ConversationMessageMetadataEvent
object
Metadata information about a message event.
2 properties
GroupSearchRequest
object
6 properties
EvaluationSettings
object
4 properties
EdgeGroup
object
17 properties 3 required
SocialExpression
object
20 properties
ConditionalGroupRouting
object
1 property
JourneyCustomerSession
object
2 properties 2 required
MediaSettings
object
5 properties
JourneyActionMap
object
2 properties 2 required
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
MessageMediaSettings
object
8 properties
Group
object
17 properties 4 required
Evaluation
object
43 properties
DefaultAnswer
object
2 properties
Location
object
5 properties
Message
object
33 properties
Segment
object
5 properties 2 required
EvaluationSource
object
4 properties
QueueMediaSettings
object
5 properties
VoicemailRetentionPolicy
object
Governs how the voicemail is retained
2 properties
DocumentationSearchResponse
object
9 properties 6 required
MessageSticker
object
2 properties
Video
object
19 properties
ErrorInfo
object
2 properties
JsonNodeSearchResponse
object
10 properties 6 required
CannedResponseLibraries
object
2 properties
DocumentationSearchRequest
object
6 properties
LocationAddress
object
7 properties
Ring
object
3 properties
TransferResponse
object
7 properties
TrunkBase
object
19 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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