GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Forms API

4 actions 4 updates phrasing extends openapi/getresponse-forms-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/forms/{formId}'].get

$.paths['/forms/{formId}/variants'].get

$.paths['/forms'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Forms API
  version: 1.0.0
extends: openapi/getresponse-forms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/forms/{formId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signup form
      effect: read
      questions:
      - Can I look up one of my signup forms by ID?
      - What settings and stats does a particular form have?
      instructions:
      - text: Get form {form}.
        slots:
          form: path.formId
      - text: Show the {fields} of signup form {form}.
        slots:
          fields: query.fields
          form: path.formId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms/{formId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a form's A/B test variants
      effect: read
      questions:
      - Which A/B test variants exist for one of my forms?
      - Can I compare the versions of a form I'm split testing?
      instructions:
      - text: List the A/B variants of form {form}.
        slots:
          form: path.formId
      - text: Show split test versions for form {form}.
        slots:
          form: path.formId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List my signup forms
      effect: read
      questions:
      - Which of my signup forms have the best subscription rate?
      - Can I list forms attached to one contact list?
      - What forms are currently published versus unpublished?
      instructions:
      - text: List all my signup forms.
      - text: List forms for list {campaign}.
        slots:
          campaign: query.query[campaignId]
      - text: Find forms with status {status}.
        slots:
          status: query.query[status]
      method: generated
      generated: '2026-09-26'