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

User and organization presences

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

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

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

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

27 operations 14 paths 53 schemas 3 DELETE13 GET2 PATCH3 POST6 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 Presence 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 27

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

Presence 27

User and organization presences

GET
/api/v2/users/presences/purecloud/bulk
Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
getUsersPresencesPurecloudBulk 1 param → 200400401403404408409413
GET
/api/v2/users/presences/{sourceId}/bulk
Get bulk user presences for a single presence source
getUsersPresenceBulk 2 params → 200400401403404408409413
PUT
/api/v2/users/presences/bulk
Update bulk user Presences
putUsersPresencesBulk 1 param → 200400401403404408409413
GET
/api/v2/presencedefinitions/{presenceId}deprecated
Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead
getPresencedefinition 2 params → 200400401403404408409413
PUT
/api/v2/presencedefinitions/{presenceId}deprecated
Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead)
putPresencedefinition 2 params → 200400401403404408409413
DELETE
/api/v2/presencedefinitions/{presenceId}deprecated
Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead
deletePresencedefinition 1 param → default400401403404408409413
GET
/api/v2/presencedefinitionsdeprecated
Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead
getPresencedefinitions 4 params → 200400401403404408409413
POST
/api/v2/presencedefinitionsdeprecated
Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead
postPresencedefinitions 1 param → 200400401403404408409413
GET
/api/v2/presence/definitions/{definitionId}
Get a Presence Definition
getPresenceDefinition 2 params → 200400401403404408409413
PUT
/api/v2/presence/definitions/{definitionId}
Update a Presence Definition
putPresenceDefinition 2 params → 200400401403404408409413
DELETE
/api/v2/presence/definitions/{definitionId}
Delete a Presence Definition
deletePresenceDefinition 1 param → 204400401403404408409413
GET
/api/v2/presence/definitions
Get a list of Presence Definitions
getPresenceDefinitions 3 params → 200400401403404408409413
POST
/api/v2/presence/definitions
Create a Presence Definition
postPresenceDefinitions 1 param → 200201400401403404408409
GET
/api/v2/presence/settings
Get the presence settings
getPresenceSettings → 200400401403404408409413
PUT
/api/v2/presence/settings
Update the presence settings
putPresenceSettings 1 param → 200400401403404408409413
GET
/api/v2/presence/sources/{sourceId}
Get a Presence Source
getPresenceSource 1 param → 200400401403404408409413
PUT
/api/v2/presence/sources/{sourceId}
Update a Presence Source
putPresenceSource 2 params → 200400401403404408409413
DELETE
/api/v2/presence/sources/{sourceId}
Delete a Presence Source
deletePresenceSource 1 param → 204400401403404408409413
GET
/api/v2/presence/sources
Get a list of Presence Sources
getPresenceSources 1 param → 200400401403404408409413
POST
/api/v2/presence/sources
Create a Presence Source
postPresenceSources 1 param → 200400401403404408409413
GET
/api/v2/systempresences
Get the list of SystemPresences
getSystempresences → 200400401403404408409413
GET
/api/v2/users/{userId}/presences/purecloud
Get a user's Genesys Cloud presence.
getUserPresencesPurecloud 1 param → 200400401403404408409413
PATCH
/api/v2/users/{userId}/presences/purecloud
Patch a Genesys Cloud user's presence
patchUserPresencesPurecloud 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/presences/{sourceId}
Get a user's Presence
getUserPresence 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/presences/{sourceId}
Patch a user's Presence
patchUserPresence 3 params → 200400401403404408409413
GET
/api/v2/presence/users/{userId}/primarysource
Get a user's Primary Presence Source
getPresenceUserPrimarysource 1 param → 200400401403404408409413
PUT
/api/v2/presence/users/{userId}/primarysource
Update a user's Primary Presence Source
putPresenceUserPrimarysource 2 params → 200400401403404408409413

Schemas 53

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

Team
object
8 properties 1 required
UserConversationSummary
object
8 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
SystemPresence
object
3 properties
Biography
object
5 properties
UserAuthorization
object
4 properties
ResourcePermissionPolicy
object
11 properties
WritableDivision
object
3 properties
OutOfOffice
object
8 properties
UserPresence
object
10 properties
OrganizationPresenceDefinition
object
8 properties 1 required
LocationEmergencyNumber
object
3 properties
RestorePresenceSettings
object
3 properties 3 required
ErrorBody
object
11 properties
UserStations
object
4 properties
LocationImage
object
2 properties
Division
object
3 properties
Detail
object
4 properties
ResourceConditionNode
object
5 properties
OAuthLastTokenIssued
object
1 property
EmployerInfo
object
4 properties
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
SourceEntityListing
object
3 properties
LocationAddress
object
7 properties
OrganizationPresence
object
11 properties 1 required
RoutingStatus
object
3 properties
UserStation
object
8 properties
ResourceConditionValue
object
2 properties
UcUserPresence
object
Presence from a given source for a user
9 properties
Contact
object
7 properties
Group
object
17 properties 4 required
Location
object
5 properties
Geolocation
object
11 properties
UserPrimarySource
object
5 properties
Limit
object
3 properties
PresenceSettings
object
6 properties
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
Source
object
6 properties 1 required
DomainRole
object
2 properties
MutableUserPresence
object
10 properties
Chat
object
1 property
OrganizationPresenceDefinitionEntityListing
object
3 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
PresenceDefinition
object
3 properties
LocationDefinition
object
16 properties
OrganizationPresenceEntityListing
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-presence-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 Presence 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.