openapi: 3.1.0
info:
  title: Gravity Forms REST API v2
  description: |
    The Gravity Forms REST API v2 provides programmatic access to forms,
    entries, submissions, validations, notifications, feeds, and results
    on a WordPress site running the Gravity Forms plugin.
  version: "2.0"
  contact:
    name: Gravity Forms
    url: https://docs.gravityforms.com/rest-api-v2/
servers:
  - url: https://{host}/wp-json/gf/v2
    description: WordPress site running Gravity Forms
    variables:
      host:
        default: example.com
        description: The hostname of the WordPress installation
security:
  - basicAuth: []
  - oauth1: []
paths:
  /forms:
    get:
      summary: List forms
      operationId: listForms
      responses:
        "200":
          description: A list of forms.
    post:
      summary: Create a form
      operationId: createForm
      responses:
        "200":
          description: The created form.
  /forms/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      summary: Get a form
      operationId: getForm
      responses:
        "200":
          description: The requested form.
    put:
      summary: Update a form
      operationId: updateForm
      responses:
        "200":
          description: The updated form.
    delete:
      summary: Delete a form
      operationId: deleteForm
      parameters:
        - in: query
          name: force
          schema:
            type: boolean
          description: Permanently delete (otherwise trashed).
      responses:
        "200":
          description: The deleted form.
  /forms/{id}/submissions:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    post:
      summary: Submit form data
      operationId: submitForm
      responses:
        "200":
          description: The submission result.
  /forms/{id}/validations:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    post:
      summary: Validate a form submission
      operationId: validateForm
      responses:
        "200":
          description: The validation result.
  /entries:
    get:
      summary: Search and list entries
      operationId: listEntries
      responses:
        "200":
          description: A list of entries.
    post:
      summary: Create an entry
      operationId: createEntry
      responses:
        "200":
          description: The created entry.
  /entries/{id}:
    parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
    get:
      summary: Get an entry
      operationId: getEntry
      responses:
        "200":
          description: The requested entry.
    put:
      summary: Update an entry
      operationId: updateEntry
      responses:
        "200":
          description: The updated entry.
    delete:
      summary: Delete an entry
      operationId: deleteEntry
      parameters:
        - in: query
          name: force
          schema:
            type: boolean
      responses:
        "200":
          description: The deleted entry.
  /notifications/send:
    post:
      summary: Send notifications
      operationId: sendNotifications
      responses:
        "200":
          description: Notification send result.
  /feeds:
    get:
      summary: List feeds
      operationId: listFeeds
      responses:
        "200":
          description: A list of feeds.
    post:
      summary: Create a feed
      operationId: createFeed
      responses:
        "200":
          description: The created feed.
  /results:
    get:
      summary: Get form results
      operationId: getResults
      responses:
        "200":
          description: Aggregated results.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic auth using a Gravity Forms REST API key/secret.
    oauth1:
      type: apiKey
      in: header
      name: Authorization
      description: OAuth 1.0a signed requests using API key/secret.