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

Me, routing, roles

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

121 operations 86 paths 244 schemas 16 DELETE56 GET11 PATCH21 POST17 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
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Users 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 121

Across 86 paths, the API surfaces 121 operations — 16 DELETE, 56 GET, 11 PATCH, 21 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 121

Me, routing, roles

GET
/api/v2/authorization/divisionspermitted/medeprecated
Returns which divisions the current user has the given permission in.
getAuthorizationDivisionspermittedMe 2 params → 200400401403404408409413
GET
/api/v2/authorization/divisionspermitted/paged/me
Returns which divisions the current user has the given permission in.
getAuthorizationDivisionspermittedPagedMe 3 params → 200400401403404408409413
GET
/api/v2/authorization/divisionspermitted/paged/{subjectId}deprecated
Returns which divisions the specified user has the given permission in.
getAuthorizationDivisionspermittedPagedSubjectId 4 params → 200400401403404408409413
GET
/api/v2/users/{userId}/verifiers
Get a list of verifiers
getUserVerifiers 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/verifiers/{verifierId}
Update a verifier
putUserVerifier 3 params → 200400401403404408409413
DELETE
/api/v2/users/{userId}/verifiers/{verifierId}
Delete a verifier
deleteUserVerifier 2 params → 204400401403404408409413
POST
/api/v2/analytics/users/aggregates/query
Query for user aggregates
postAnalyticsUsersAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/aggregates/jobs
Query for user aggregates asynchronously
postAnalyticsUsersAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/users/aggregates/jobs/{jobId}
Get status for async query for user aggregates
getAnalyticsUsersAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/users/aggregates/jobs/{jobId}
Delete/cancel an async request for user aggregates
deleteAnalyticsUsersAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/users/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsUsersAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/users/details/query
Query for user details
postAnalyticsUsersDetailsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/observations/query
Query for user observations
postAnalyticsUsersObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/users/activity/query
Query for user activity observations
postAnalyticsUsersActivityQuery 3 params → 200400401403404408409413
POST
/api/v2/analytics/users/details/jobs
Query for user details asynchronously
postAnalyticsUsersDetailsJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/users/details/jobs/{jobId}
Get status for async query for user details
getAnalyticsUsersDetailsJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/users/details/jobs/{jobId}
Delete/cancel an async request
deleteAnalyticsUsersDetailsJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/users/details/jobs/{jobId}/results
Fetch a page of results for an async query
getAnalyticsUsersDetailsJobResults 3 params → 200400401403404408409413
GET
/api/v2/analytics/users/details/jobs/availability
Lookup the datalake availability date and time
getAnalyticsUsersDetailsJobsAvailability → 200400401403404408409413
GET
/api/v2/authorization/subjects/me
Returns a listing of roles and permissions for the currently authenticated user.
getAuthorizationSubjectsMe 1 param → 200400401403404408409413
GET
/api/v2/authorization/subjects/{subjectId}
Returns a listing of roles and permissions for a user.
getAuthorizationSubject 2 params → 200400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
Make a grant of a role in a division
postAuthorizationSubjectDivisionRole 4 params → default400401403404408409413
DELETE
/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
Delete a grant of a role in a division
deleteAuthorizationSubjectDivisionRole 3 params → default400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkadd
Bulk-grant roles and divisions to a subject.
postAuthorizationSubjectBulkadd 3 params → 204400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkreplace
Replace subject's roles and divisions with the exact list supplied in the request.
postAuthorizationSubjectBulkreplace 3 params → 204400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkremove
Bulk-remove grants from a subject.
postAuthorizationSubjectBulkremove 2 params → 204400401403404408409413
GET
/api/v2/users/{subjectId}/roles
Returns a listing of roles and permissions for a user.
getUserRoles 1 param → 200400401403404408409413
PUT
/api/v2/users/{subjectId}/roles
Sets the user's roles
putUserRoles 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/callforwarding
Get a user's CallForwarding
getUserCallforwarding 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/callforwarding
Update a user's CallForwarding
putUserCallforwarding 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/callforwarding
Patch a user's CallForwarding
patchUserCallforwarding 2 params → 200400401403404408409413
GET
/api/v2/fieldconfigdeprecated
Fetch field config for an entity type
getFieldconfig 1 param → 200400401403404408409413
GET
/api/v2/users/{userId}/favoritesdeprecated
Deprecated; will be revived with new contract
getUserFavorites 5 params → 200400401403404408409413
GET
/api/v2/users/{userId}/adjacents
Get adjacents
getUserAdjacents 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/superiors
Get superiors
getUserSuperiors 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/directreports
Get direct reports
getUserDirectreports 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/profiledeprecated
Get user profile
getUserProfile 3 params → 200400401403404408409413
GET
/api/v2/profiles/usersdeprecated
Get a user profile listing
getProfilesUsers 7 params → 200400401403404408409413
GET
/api/v2/users/{userId}/geolocations/{clientId}
Get a user's Geolocation
getUserGeolocation 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/geolocations/{clientId}
Patch a user's Geolocation
patchUserGeolocation 3 params → 200400401403404408409413
GET
/api/v2/users/{userId}/outofoffice
Get a OutOfOffice
getUserOutofoffice 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/outofoffice
Update an OutOfOffice
putUserOutofoffice 2 params → 200400401403404408409413
GET
/api/v2/routing/directroutingbackup/settings/me
Get the user's Direct Routing Backup settings.
getRoutingDirectroutingbackupSettingsMe → 200400401403404408409413
PUT
/api/v2/routing/directroutingbackup/settings/me
Update the user's Direct Routing Backup settings.
putRoutingDirectroutingbackupSettingsMe 1 param → 200400401403404408409413
DELETE
/api/v2/routing/directroutingbackup/settings/me
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
deleteRoutingDirectroutingbackupSettingsMe → 204400401403404408409413
GET
/api/v2/routing/users/{userId}/directroutingbackup/settings
Get the user's Direct Routing Backup settings.
getRoutingUserDirectroutingbackupSettings 1 param → 200400401403404408409413
PUT
/api/v2/routing/users/{userId}/directroutingbackup/settings
Update the user's Direct Routing Backup settings.
putRoutingUserDirectroutingbackupSettings 2 params → 200400401403404408409413
DELETE
/api/v2/routing/users/{userId}/directroutingbackup/settings
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
deleteRoutingUserDirectroutingbackupSettings 1 param → 204400401403404408409413
GET
/api/v2/routing/users/{userId}/utilization
Get the user's max utilization settings. If not configured, the organization-wide default is returned.
getRoutingUserUtilization 1 param → 200400401403404408409413
PUT
/api/v2/routing/users/{userId}/utilization
Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
putRoutingUserUtilization 2 params → 200400401403404408409413
DELETE
/api/v2/routing/users/{userId}/utilization
Delete the user's max utilization settings and revert to the organization-wide default.
deleteRoutingUserUtilization 1 param → 200400401403404408409413
GET
/api/v2/users/chats/me
Get chats for a user
getUsersChatsMe 4 params → 200400401403404408409413
GET
/api/v2/users/externalid/{authorityName}/{externalKey}
Get the user associated with external identifier.
getUsersExternalidAuthorityNameExternalKey 3 params → 200400401403404408409413
GET
/api/v2/users/{userId}/externalid/{authorityName}
Get the external identifier of user for an authority.
getUserExternalidAuthorityName 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/externalid
Get the external identifiers for a user.
getUserExternalid 1 param → 200400401403404408409413
POST
/api/v2/users/{userId}/externalid
Create mapping between external identifier and user. Limit 100 per entity.
postUserExternalid 2 params → 200201400401403404408409
DELETE
/api/v2/users/{userId}/externalid/{authorityName}/{externalKey}
Delete the external identifier for user.
deleteUserExternalidAuthorityNameExternalKey 3 params → 204400401403404408409413
POST
/api/v2/users/me/password
Change your password
postUsersMePassword 1 param → 204400401403404408409413
GET
/api/v2/users/me
Get current user details.
getUsersMe 3 params → 200400401403404408409413
POST
/api/v2/users/{userId}/password
Change a users password
postUserPassword 2 params → 204400401403404408409413
GET
/api/v2/users/{userId}/profileskills
List profile skills for a user
getUserProfileskills 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/profileskills
Update profile skills for a user
putUserProfileskills 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/queues/{queueId}
Join or unjoin a queue for a user
patchUserQueue 3 params → 200400401403404408409413
GET
/api/v2/users/{userId}/queues
Get queues for user
getUserQueues 5 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/queues
Join or unjoin a set of queues for a user
patchUserQueues 3 params → 200400401403404408409413
GET
/api/v2/users/{userId}
Get user.
getUser 5 params → 200400401403404408409413
DELETE
/api/v2/users/{userId}
Delete user
deleteUser 1 param → 200400401403404408409413
PATCH
/api/v2/users/{userId}
Update user
patchUser 2 params → 200409400401403404408413
POST
/api/v2/users/{userId}/invite
Send an activation email to the user
postUserInvite 2 params → 204400401403404408409413
DELETE
/api/v2/users/{userId}/routinglanguages/{languageId}
Remove a routing language from a user
deleteUserRoutinglanguage 2 params → 204400401403404408409413
PATCH
/api/v2/users/{userId}/routinglanguages/{languageId}
Update an assigned routing language's proficiency
patchUserRoutinglanguage 3 params → 200409400401403404408413
GET
/api/v2/users/{userId}/routinglanguages
List routing languages assigned to a user
getUserRoutinglanguages 4 params → 200400401403404408409413
POST
/api/v2/users/{userId}/routinglanguages
Assign a routing language to a user
postUserRoutinglanguages 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/routinglanguages/bulk
Assign multiple routing languages to a user. Max 50 routing languages in request body
patchUserRoutinglanguagesBulk 2 params → 200400401403404408409413
PUT
/api/v2/users/{userId}/routingskills/{skillId}
Update an assigned routing skill's proficiency
putUserRoutingskill 3 params → 200409400401403404408413
DELETE
/api/v2/users/{userId}/routingskills/{skillId}
Remove a routing skill from a user
deleteUserRoutingskill 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/routingskills
List routing skills assigned to a user
getUserRoutingskills 4 params → 200400401403404408409413
POST
/api/v2/users/{userId}/routingskills
Assign a routing skill to a user
postUserRoutingskills 2 params → 200400401403404408409413
PUT
/api/v2/users/{userId}/routingskills/bulk
Assign multiple routing skills to a user, replacing any current assignments
putUserRoutingskillsBulk 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/routingskills/bulk
Assign multiple routing skills to a user
patchUserRoutingskillsBulk 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/routingstatus
Fetch the routing status of a user
getUserRoutingstatus 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/routingstatus
Update the routing status of a user
putUserRoutingstatus 2 params → 200400401403404408409413
GET
/api/v2/users/stations/me
Get station information for self
getUsersStationsMe → 200400401403404408409413
DELETE
/api/v2/users/stations/me/associatedstation
Clear self associated station
deleteUsersStationsMeAssociatedstation → 204400401403404408409413
PUT
/api/v2/users/stations/me/associatedstation/{stationId}
Set self associated station
putUsersStationsMeAssociatedstationStationId 1 param → 204400401403404408409413
GET
/api/v2/users/{userId}/skillgroups
Get skill groups for a user
getUserSkillgroups 4 params → 200400401403404408409413
GET
/api/v2/users/{userId}/state
Get user state information.
getUserState 1 param → 200400401403404408409413
PUT
/api/v2/users/{userId}/state
Update user state information.
putUserState 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/station
Get station information for user
getUserStation 1 param → 200400401403404408409413
DELETE
/api/v2/users/{userId}/station/associatedstation
Clear associated station
deleteUserStationAssociatedstation 1 param → 202400401403404408409413
PUT
/api/v2/users/{userId}/station/associatedstation/{stationId}
Set associated station
putUserStationAssociatedstationStationId 2 params → 202400401403404408409413
PUT
/api/v2/users/{userId}/station/defaultstation/{stationId}
Set default station
putUserStationDefaultstationStationId 2 params → 202400401403404408409413
DELETE
/api/v2/users/{userId}/station/defaultstation
Clear default station
deleteUserStationDefaultstation 1 param → 202400401403404408409413
GET
/api/v2/users/{userId}/trustors
List the organizations that have authorized/trusted the user.
getUserTrustors 3 params → 200400401403404408409413
PATCH
/api/v2/users/bulk
Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
patchUsersBulk 1 param → 200400401403404408409413
GET
/api/v2/users/query
Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
getUsersQuery 7 params → 200400401403404408409413
GET
/api/v2/users
Get the list of available users.
getUsers 9 params → 200400401403404408409413
POST
/api/v2/users
Create user
postUsers 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/users/customattributes/schemas/coretypes/{coreTypeName}
Get the core types from which all schemas are built.
getUsersCustomattributesSchemasCoretype 1 param → 200400401403404408409413
GET
/api/v2/users/customattributes/schemas/coretypes
Get the list of core types enabled for a specific namespace.
getUsersCustomattributesSchemasCoretypes → 200400401403404408409413
PUT
/api/v2/users/{userId}/customattributes
Create or update a single custom attributes record. Updating replaces all data with the provided fields.
putUserCustomattributes 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/customattributes
Update a single custom attributes record by amending the data with only the provided fields.
patchUserCustomattributes 2 params → 200204400401403404408409
GET
/api/v2/users/{userId}/customattributes/{schemaId}
Get custom attributes by schema id
getUserCustomattribute 2 params → 200400401403404408409413
DELETE
/api/v2/users/{userId}/customattributes/{schemaId}
Delete a custom attributes record.
deleteUserCustomattribute 2 params → 204400401403404408409413
GET
/api/v2/users/{userId}/customattributes/bulk
Get multiple custom attributes records by schema ids
getUserCustomattributesBulk 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/customattributes/bulk
Update multiple custom attributes records by amending the data with only the provided fields.
patchUserCustomattributesBulk 2 params → 200204400401403404408409
GET
/api/v2/users/customattributes/schemas/limits
Get quantitative limits on schemas
getUsersCustomattributesSchemasLimits → 200400401403404408409413
GET
/api/v2/users/customattributes/schemas/{schemaId}
Get a schema
getUsersCustomattributesSchema 1 param → 200400401403404408409413
PUT
/api/v2/users/customattributes/schemas/{schemaId}
Update a schema
putUsersCustomattributesSchema 2 params → 200400401403404408409413
DELETE
/api/v2/users/customattributes/schemas/{schemaId}
Delete a schema
deleteUsersCustomattributesSchema 1 param → 204400401403404408409413
GET
/api/v2/users/customattributes/schemas/{schemaId}/versions
Get all versions of a user schema
getUsersCustomattributesSchemaVersions 1 param → 200400401403404408409413
GET
/api/v2/users/customattributes/schemas/{schemaId}/versions/{versionId}
Get a specific version of a schema
getUsersCustomattributesSchemaVersion 2 params → 200400401403404408409413
GET
/api/v2/users/customattributes/schemas
Get a list of schemas.
getUsersCustomattributesSchemas → 200400401403404408409413
POST
/api/v2/users/customattributes/schemas
Create a schema
postUsersCustomattributesSchemas 1 param → 200400401403404408409413
GET
/api/v2/users/development/activities
Get list of Development Activities
getUsersDevelopmentActivities 12 params → 200400401403404408409413
GET
/api/v2/users/development/activities/me
Get list of Development Activities for current user
getUsersDevelopmentActivitiesMe 11 params → 200400401403404408409413
GET
/api/v2/users/development/activities/{activityId}
Get a Development Activity
getUsersDevelopmentActivity 2 params → 200400401403404408409413
POST
/api/v2/users/development/activities/aggregates/query
Retrieve aggregated development activity data
postUsersDevelopmentActivitiesAggregatesQuery 1 param → 200400401403404408409413

Schemas 244

The contract defines 244 schemas that model the data the API accepts and returns. The most detailed are UserMe (56 properties), QueueFullReference (41 properties), UserQueue (41 properties), User (39 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
WorkPlanBidRanks
object
4 properties
Trustor
object
7 properties 1 required
AddressableEntityRef
object
2 properties
AuthzGrantRole
object
6 properties
JsonSchemaDocument
object
A JSON Schema document.
8 properties
UserAsyncAggregationQuery
object
10 properties 2 required
TokenInfo
object
6 properties
AsyncQueryStatus
object
5 properties
ResourcePermissionPolicy
object
11 properties
AuthzGrantPolicy
object
4 properties
UserActivityQueryMetric
object
2 properties 1 required
UserObservationQueryPredicate
object
5 properties
WritableDivision
object
3 properties
CallTarget
object
2 properties
ChangeMyPasswordRequest
object
2 properties 2 required
StatisticalResponse
object
3 properties
UserAggregateDataContainer
object
2 properties
AggregateViewData
object
2 properties
UserObservationQueryClause
object
2 properties 2 required
UserEntityListing
object
10 properties
UserStations
object
4 properties
Ring
object
3 properties
UserDetailQueryClause
object
2 properties 2 required
Script
object
15 properties
OAuthLastTokenIssued
object
1 property
UserActivityQuery
object
4 properties 2 required
ChatItem
object
11 properties 2 required
StatisticalSummary
object
14 properties
ConditionalGroupActivationPilotRule
object
2 properties
MediaSummary
object
2 properties
CoretypeListing
object
3 properties
LocationAddressVerificationDetails
object
4 properties
AcwSettings
object
2 properties
UserAggregateQueryResponse
object
2 properties
OrganizationPresence
object
11 properties 1 required
UserAggregationView
object
4 properties 3 required
ExpansionCriterium
object
2 properties
DomainOrganizationRole
object
15 properties
RoleDivisionPair
object
2 properties 2 required
DirectRoutingMediaSettings
object
1 property
MaxLength
object
2 properties 2 required
UserActivityData
object
4 properties
UserProfileEntityListing
object
10 properties
DevelopmentActivityAggregateQueryResponseMetric
object
2 properties
Geolocation
object
11 properties
SkillGroupRoutingCondition
object
4 properties 3 required
UserActivityEntityData
object
10 properties 1 required
UserSearchRequest
object
9 properties
PresenceDetailQueryFilter
object
3 properties 1 required
UserActivityQueryFilter
object
3 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
DevelopmentActivity
object
Development Activity object
17 properties
FieldList
object
10 properties
UserQueueEntityListing
object
10 properties
Room
object
11 properties
ConditionalGroupActivationCondition
object
3 properties
Page
object
8 properties
Section
object
4 properties
UserAggregateQueryFilter
object
3 properties 1 required
UserExpands
object
8 properties
UserActivityMetricValue
object
4 properties
AggregationResult
object
5 properties
AsyncQueryResponse
object
1 property
AnalyticsRoutingStatusRecord
object
3 properties
DevelopmentActivityAggregateQueryResponseStatistics
object
4 properties
CallRoute
object
1 property
UserExternalIdentifier
object
Defines a link between an External Identifier and Authority pair to a Entity Type and Entity Identifier pair. Represents the two way, one to one mapping of an…
3 properties 2 required
UserSearchCriteria
object
9 properties 1 required
DataSchemaListing
object
3 properties
RoutingSkill
object
6 properties 1 required
CreateUser
object
8 properties 3 required
GeolocationSettings
object
5 properties
DevelopmentActivityAggregateQueryRequestClause
object
2 properties 2 required
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
UserRoutingLanguagePost
object
Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id.
4 properties 2 required
Biography
object
5 properties
UserObservationDataContainer
object
2 properties
TrusteeAuthorization
object
1 property
DevelopmentActivityAggregateQueryRequestPredicate
object
2 properties 2 required
AnalyticsScoredAgent
object
2 properties
EmailMediaSettings
object
5 properties
AnalyticsUserDetailsAsyncQueryResponse
object
3 properties
LabelUtilizationResponse
object
3 properties
SkillGroupLanguageCondition
object
4 properties 3 required
ObservationMetricData
object
5 properties
ChatItemCursorListing
object
4 properties
ResourceConditionNode
object
5 properties
ConditionalGroupActivation
object
2 properties
SkillGroup
object
10 properties 2 required
NumericRange
object
4 properties
TeamFullReference
object
8 properties 1 required
MinLength
object
2 properties 2 required
ChatPresence
object
6 properties
UserLanguageEntityListing
object
10 properties
ObservationValue
object
19 properties 1 required
UserAggregateQueryPredicate
object
5 properties
MessageSubtypeSettings
object
2 properties
EmailAddress
object
2 properties
UserObservationQueryFilter
object
3 properties 1 required
DomainEntityRef
object
3 properties
Empty
object
AuthzDivision
object
6 properties 1 required
QueueMessagingAddresses
object
3 properties
DomainPermissionPolicy
object
8 properties
InactivityTimeoutSettings
object
3 properties
DomainRole
object
2 properties
DomainResourceConditionValue
object
5 properties
SearchSort
object
2 properties
DevelopmentActivityAggregateResponse
object
1 property
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
UserActivityResponse
object
2 properties
OrgUser
object
39 properties 1 required
ServiceLevel
object
2 properties
PresenceDefinition
object
3 properties
AgentDirectRoutingBackupSettings
object
5 properties
Signature
object
4 properties
UpdateVerifierRequest
object
3 properties
MemberGroup
object
6 properties
AutoAnswerSetting
object
1 property 1 required
Detail
object
4 properties
Organization
object
15 properties 1 required
AnalyticsUserDetailsQueryResponse
object
3 properties
UserObservationQuery
object
3 properties 2 required
MediaUtilization
object
3 properties
DataSchema
object
9 properties 2 required
DomainOrganizationProduct
object
1 property
UserAuthorization
object
4 properties
OutOfOffice
object
8 properties
ValidationLimits
object
6 properties
UserPresence
object
10 properties
ServerDate
object
1 property
LocationEmergencyNumber
object
3 properties
RoutingStatusDetailQueryFilter
object
3 properties 1 required
OrganizationPresenceDefinition
object
8 properties 1 required
DirectRouting
object
6 properties
Entity
object
1 property
TokenInfoClonedUser
object
2 properties
DivsPermittedEntityListing
object
11 properties
ChatFavorite
object
2 properties 2 required
UserAggregationQuery
object
9 properties 2 required
EmployerInfo
object
4 properties
SkillsToRemove
object
3 properties
RoleDivision
object
2 properties 2 required
UtilizationRequest
object
3 properties
UserActivityQueryClause
object
2 properties 2 required
AggregateMetricData
object
3 properties
DevelopmentActivityListing
object
10 properties
UserRoutingSkillPost
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
4 properties 2 required
RoutingStatus
object
3 properties
RoutingRule
object
3 properties
RoleDivisionGrants
object
1 property 1 required
ResourceConditionValue
object
2 properties
UpdateUser
object
22 properties 1 required
UserState
object
4 properties
UsersSearchResponse
object
9 properties 6 required
FieldConfig
object
8 properties
AnalyticsQueryAggregation
object
5 properties
InboundRoute
object
19 properties 2 required
UserCustomAttributes
object
6 properties 1 required
PatchUser
object
2 properties
OrgOAuthClient
object
12 properties 2 required
Limit
object
3 properties
CallbackMediaSettings
object
18 properties
DevelopmentActivityAggregateQueryRequestFilter
object
2 properties 2 required
AnalyticsUserPresenceRecord
object
4 properties
UserAggregateQueryClause
object
2 properties 2 required
DevelopmentActivityAggregateParam
object
4 properties 2 required
UserActivityQueryPredicate
object
4 properties
DevelopmentActivityAggregateQueryResponseData
object
2 properties
Chat
object
1 property
GroupContact
object
5 properties 3 required
CallForwarding
object
9 properties
PresenceDetailQueryClause
object
2 properties 2 required
Contact
object
7 properties
LocationDefinition
object
16 properties
QueueEmailAddress
object
2 properties
UserDetailsQuery
object
8 properties 1 required
UserAsyncAggregateQueryResponse
object
3 properties
Items
object
2 properties
AgentOwnedRouting
object
3 properties
DevelopmentActivityAggregateQueryResponseGroupedData
object
2 properties
UserConversationSummary
object
8 properties
Image
object
2 properties
Actions
object
1 property
Verifier
object
5 properties
SchemaQuantityLimits
object
16 properties
Education
object
5 properties
RoutingStatusDetailQueryClause
object
2 properties 2 required
RoutingStatusDetailQueryPredicate
object
5 properties
ConditionalGroupRoutingRule
object
6 properties
QueueFullReference
object
41 properties
Coretype
object
11 properties
UserReference
object
2 properties
AuthzGrant
object
4 properties
UserDetailQueryPredicate
object
5 properties
Bullseye
object
1 property
UserSkillEntityListing
object
10 properties
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
DomainResourceConditionNode
object
5 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
UserCursorEntityListing
object
5 properties
UserSkillGroupEntityListing
object
4 properties
PresenceDetailQueryPredicate
object
5 properties
PagingSpec
object
2 properties 2 required
AggregationResultEntry
object
4 properties
ConditionalGroupRouting
object
1 property
MediaSettings
object
5 properties
UserFullReference
object
39 properties 1 required
UserProfile
object
7 properties 1 required
VerifierEntityListing
object
3 properties
ChatUserRef
object
7 properties
UserMe
object
56 properties 1 required
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
LabelUtilizationRequest
object
2 properties
UserQueue
object
41 properties
MessageMediaSettings
object
8 properties
AnalyticsUserDetail
object
3 properties
Group
object
17 properties 4 required
ChangePasswordRequest
object
1 property 1 required
Location
object
5 properties
UserDetailQueryFilter
object
3 properties 1 required
UserObservationQueryResponse
object
1 property
NamedEntity
object
2 properties
Adjacents
object
3 properties
AutoAnswerSettings
object
1 property 1 required
QueueMediaSettings
object
5 properties
DataAvailabilityResponse
object
1 property
AgentMaxUtilizationResponse
object
4 properties
SkillGroupCondition
object
3 properties 3 required
UserCustomAttributesUpdateRequest
object
3 properties 1 required
Schema
object
5 properties
CannedResponseLibraries
object
2 properties
TrustorEntityListing
object
10 properties
AuthzSubject
object
5 properties
AggregationRange
object
2 properties
FieldConfigs
object
3 properties
LocationAddress
object
7 properties
ItemValidationLimits
object
2 properties 2 required
AsyncUserDetailsQuery
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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