Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• enabled-for-internal-use boolean

  Status to be considered for filtering

• enabled-for-customer-use boolean

  Status to be considered for filtering

• offset string(positive-integer)

  Offset for the results to be returned

  Default value is 0.

• limit string(positive-integer)

  Limitation for the number of results to be returned

  Default value is 25.

• with-deleted boolean

  Includes deleted resources in the results

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • enabledForInternalUse boolean Required
    • enabledForCustomerUse boolean Required
    • order integer Required

      Minimum value is 0.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • name object | null Required

      Additional properties are NOT allowed.

      Hide name attributes Show name attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
    • description object | null Required

      Additional properties are NOT allowed.

      Hide description attributes Show description attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
    • instructions object | null Required

      Additional properties are NOT allowed.

      Hide instructions attributes Show instructions attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
    • subjectGroup object Required

      Additional properties are NOT allowed.

      Hide subjectGroup attribute Show subjectGroup attribute object

      • id string Required

        Minimum length is 1.

    • cancellationByAgentForm object | null

      Additional properties are NOT allowed.

      Hide cancellationByAgentForm attribute Show cancellationByAgentForm attribute object | null

      • id string Required

        Minimum length is 1.

    • cancellationByCustomerForm object | null

      Additional properties are NOT allowed.

      Hide cancellationByCustomerForm attribute Show cancellationByCustomerForm attribute object | null

      • id string Required

        Minimum length is 1.

    • completionByAgentForm object | null

      Additional properties are NOT allowed.

      Hide completionByAgentForm attribute Show completionByAgentForm attribute object | null

      • id string Required

        Minimum length is 1.

    • questionnaireForm object | null

      Additional properties are NOT allowed.

      Hide questionnaireForm attribute Show questionnaireForm attribute object | null

      • id string Required

        Minimum length is 1.

    • createdAt string(date-time) Required

      Minimum length is 1.

    • updatedAt string(date-time) Required

      Minimum length is 1.

    • deletedAt string(date-time) | null Required

      Minimum length is 1.

  • meta object Required

    Additional properties are NOT allowed.

    Hide meta attributes Show meta attributes object

    • offset integer Required

      Minimum value is 0. Default value is 0.

    • limit integer Required

      Minimum value is 0. Default value is 25.

    • totalCount integer Required

      Minimum value is 0.