Genesys Cloud - Developer Community!

 View Only

Sign Up

Discrepancy Between Actual API Response and API Explorer Schema

  • 1.  Discrepancy Between Actual API Response and API Explorer Schema

    Posted 06-11-2025 03:45

    Hi Team,

    We have observed discrepancies between the actual API responses and the schema definitions provided in the Genesys Cloud API Explorer.

    For example, in one of the API responses, we are receiving an additional attribute (contextId) within the questionGroups object that is not documented in the API Explorer schema.

    Actual API Response (excerpt):

    json
    "questionGroups": [ { "id": "9cb19350-14cd-4edd-bffb-5fd2f35b69d8", "contextId": "2ec90ace-1884-45c3-9376-a44916e3f671", "name": "Survey Questions", "type": "questionGroup", "naEnabled": false, "questions": [...] } ]

    Schema in API Explorer:

    scss
    questionGroups (SurveyQuestionGroup[]) - id (string) - name (string) - type (string) - naEnabled (boolean)

    This is just one example - we are noticing similar mismatches across multiple APIs, where the actual response includes attributes not defined in the documented schema.

    Could you please help us understand:

    • Why these discrepancies exist?

    • Is there a master or up-to-date schema reference we should rely on for integration purposes?


    #PlatformAPI

    ------------------------------
    Ameya Phadtare
    Managment Consultant
    ------------------------------