{"library":"purecloudplatformclientv2","title":"PureCloud Platform API SDK","description":"The `PureCloudPlatformClientV2` library is the official Python SDK for interacting with the Genesys Cloud Platform API. It provides a comprehensive set of classes and methods generated from the API's Swagger definition, allowing developers to programmatically manage various aspects of their Genesys Cloud environment. The library is actively maintained by Genesys Developer Evangelists, with releases tied to the Genesys Cloud API's update cadence, typically following Semantic Versioning to reflect changes in the underlying API. The current version is 254.0.0.","language":"python","status":"active","last_verified":"Tue May 19","install":{"commands":["pip install PureCloudPlatformClientV2"],"cli":null},"imports":["import PureCloudPlatformClientV2","import PureCloudPlatformClientV2.api_client\napi_client = PureCloudPlatformClientV2.api_client.ApiClient()","PureCloudPlatformClientV2.configuration","auth_api = PureCloudPlatformClientV2.AuthorizationApi(api_client)","from PureCloudPlatformClientV2 import YearMonth","from PureCloudPlatformClientV2 import ApiNullValue"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import PureCloudPlatformClientV2\nimport os\n\n# Configure API client with Client Credentials Grant\n# Ensure GENESYS_CLOUD_CLIENT_ID and GENESYS_CLOUD_CLIENT_SECRET are set as environment variables\nCLIENT_ID = os.environ.get('GENESYS_CLOUD_CLIENT_ID', '')\nCLIENT_SECRET = os.environ.get('GENESYS_CLOUD_CLIENT_SECRET', '')\nGENESYS_CLOUD_REGION = os.environ.get('GENESYS_CLOUD_REGION', 'mypurecloud.com') # e.g., mypurecloud.ie\n\n# Set the Genesys Cloud region (e.g., 'mypurecloud.ie', 'mypurecloud.com.au')\n# Default is mypurecloud.com\nPureCloudPlatformClientV2.configuration.host = f'https://api.{GENESYS_CLOUD_REGION}'\n\napi_client = PureCloudPlatformClientV2.api_client.ApiClient()\n\ntry:\n    # Authenticate using client credentials\n    api_client.get_client_credentials_token(CLIENT_ID, CLIENT_SECRET)\n    print(\"Authentication successful!\")\n\n    # Instantiate an API class (e.g., UsersApi)\n    users_api = PureCloudPlatformClientV2.UsersApi(api_client)\n\n    # Make an API call (e.g., get the authenticated user's information)\n    me = users_api.get_users_me()\n    print(f\"Authenticated user: {me.name} (ID: {me.id})\")\n\nexcept PureCloudPlatformClientV2.rest.ApiException as e:\n    print(f\"Exception when calling Genesys Cloud API: {e}\")\n    print(f\"Ensure GENESYS_CLOUD_CLIENT_ID and GENESYS_CLOUD_CLIENT_SECRET are set correctly and have the necessary permissions.\")\nexcept Exception as e:\n    print(f\"An unexpected error occurred: {e}\")","lang":"python","description":"This quickstart demonstrates how to authenticate using the Client Credentials Grant and fetch the current user's details. Ensure your `GENESYS_CLOUD_CLIENT_ID`, `GENESYS_CLOUD_CLIENT_SECRET`, and optionally `GENESYS_CLOUD_REGION` are set as environment variables. This grant type is suitable for non-human applications or services.","tag":"verified","tag_description":"quickstart runs on critical runtimes, recently tested","last_tested":"2026-04-24","results":[{"runtime":"python:3.10-alpine","exit_code":0},{"runtime":"python:3.10-slim","exit_code":0},{"runtime":"python:3.11-alpine","exit_code":0},{"runtime":"python:3.11-slim","exit_code":0},{"runtime":"python:3.12-alpine","exit_code":0},{"runtime":"python:3.12-slim","exit_code":0},{"runtime":"python:3.13-alpine","exit_code":0},{"runtime":"python:3.13-slim","exit_code":0},{"runtime":"python:3.9-alpine","exit_code":0},{"runtime":"python:3.9-slim","exit_code":0}]},"compatibility":{"tag":"verified","tag_description":"installs cleanly on critical runtimes, fast import, recently tested","last_tested":"2026-05-19","installed_version":"238.0.0","pypi_latest":"257.1.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":10.1,"avg_import_s":9.1,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"noisy","install_time_s":null,"import_time_s":5.95,"mem_mb":153,"disk_size":"164.5M"},{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":5.43,"mem_mb":151.8,"disk_size":"164.2M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"noisy","install_time_s":9.8,"import_time_s":3.45,"mem_mb":153,"disk_size":"165M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":3.6,"mem_mb":151.8,"disk_size":"165M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"noisy","install_time_s":null,"import_time_s":26.7,"mem_mb":177.2,"disk_size":"185.3M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":25.65,"mem_mb":175.7,"disk_size":"254.4M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"noisy","install_time_s":9.4,"import_time_s":22.18,"mem_mb":177.2,"disk_size":"186M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":22,"mem_mb":175.7,"disk_size":"255M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"noisy","install_time_s":null,"import_time_s":6.41,"mem_mb":173.9,"disk_size":"172.8M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":6.68,"mem_mb":172.6,"disk_size":"241.9M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"noisy","install_time_s":10.1,"import_time_s":6.34,"mem_mb":173.9,"disk_size":"173M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":6.79,"mem_mb":172.6,"disk_size":"242M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"noisy","install_time_s":null,"import_time_s":6.13,"mem_mb":170.8,"disk_size":"167.9M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":6.48,"mem_mb":169.5,"disk_size":"236.9M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"noisy","install_time_s":10.3,"import_time_s":6.28,"mem_mb":170.8,"disk_size":"168M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":6.57,"mem_mb":169.5,"disk_size":"237M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":3.98,"mem_mb":155.5,"disk_size":"153.7M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":4.35,"mem_mb":155.5,"disk_size":"153.7M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":11.1,"import_time_s":3.52,"mem_mb":155.5,"disk_size":"154M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"PureCloudPlatformClientV2","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":3.62,"mem_mb":155.5,"disk_size":"154M"}]}}