Fieldwire Forms API — Form Templates

naftiko: 1.0.0-alpha2
info:
  label: Fieldwire Forms API — Form Templates
  description: Account-level Fieldwire form templates, sections, and inputs.
  tags: [Fieldwire, Forms, Templates, Construction]
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    FIELDWIRE_ACCESS_TOKEN: FIELDWIRE_ACCESS_TOKEN
capability:
  consumes:
  - type: http
    namespace: forms-form-templates
    baseUri: https://client-api.super.fieldwire.com
    description: Fieldwire Form Templates business capability.
    resources:
    - name: account-form-templates
      path: /account/form_templates
      operations:
      - name: getaccountformtemplates
        method: GET
        description: Get Account Form Templates
        outputParameters: [{ name: result, type: array, value: $. }]
      - name: createaccountformtemplate
        method: POST
        description: Create Account Form Template
        inputParameters: [{ name: body, in: body, type: object, required: true }]
        outputParameters: [{ name: result, type: object, value: $. }]
    - name: account-form-template
      path: /account/form_templates/{form_template_id}
      operations:
      - name: getaccountformtemplatebyid
        method: GET
        description: Get Account Form Template By ID
        inputParameters: [{ name: form_template_id, in: path, type: integer, required: true }]
        outputParameters: [{ name: result, type: object, value: $. }]
      - name: updateaccountformtemplatebyid
        method: PATCH
        description: Update Account Form Template By ID
        inputParameters:
        - { name: form_template_id, in: path, type: integer, required: true }
        - { name: body, in: body, type: object, required: true }
        outputParameters: [{ name: result, type: object, value: $. }]
    authentication:
      type: bearer
      value: '{{env.FIELDWIRE_ACCESS_TOKEN}}'
      placement: header
  exposes:
  - type: rest
    namespace: forms-form-templates-rest
    port: 8080
    description: REST adapter for Fieldwire Form Templates.
    resources:
    - path: /v1/account/form_templates
      name: account-form-templates
      operations:
      - method: GET
        name: getaccountformtemplates
        call: forms-form-templates.getaccountformtemplates
        outputParameters: [{ type: array, mapping: $. }]
      - method: POST
        name: createaccountformtemplate
        call: forms-form-templates.createaccountformtemplate
        with: { body: rest.body }
        outputParameters: [{ type: object, mapping: $. }]
    - path: /v1/account/form_templates/{form_template_id}
      name: account-form-template
      operations:
      - method: GET
        name: getaccountformtemplatebyid
        call: forms-form-templates.getaccountformtemplatebyid
        with: { form_template_id: rest.path.form_template_id }
        outputParameters: [{ type: object, mapping: $. }]
      - method: PATCH
        name: updateaccountformtemplatebyid
        call: forms-form-templates.updateaccountformtemplatebyid
        with: { form_template_id: rest.path.form_template_id, body: rest.body }
        outputParameters: [{ type: object, mapping: $. }]
  - type: mcp
    namespace: forms-form-templates-mcp
    port: 9090
    transport: http
    description: MCP adapter for Fieldwire Form Templates.
    tools:
    - name: fieldwire-list-form-templates
      description: List account-level Fieldwire form templates.
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: forms-form-templates.getaccountformtemplates
      outputParameters: [{ type: array, mapping: $. }]
    - name: fieldwire-create-form-template
      description: Create a new account-level Fieldwire form template.
      hints: { readOnly: false, destructive: false, idempotent: false }
      call: forms-form-templates.createaccountformtemplate
      with: { body: tools.body }
      outputParameters: [{ type: object, mapping: $. }]
    - name: fieldwire-get-form-template
      description: Get a Fieldwire account-level form template by ID.
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: forms-form-templates.getaccountformtemplatebyid
      with: { form_template_id: tools.form_template_id }
      outputParameters: [{ type: object, mapping: $. }]
    - name: fieldwire-update-form-template
      description: Update a Fieldwire account-level form template.
      hints: { readOnly: false, destructive: false, idempotent: false }
      call: forms-form-templates.updateaccountformtemplatebyid
      with: { form_template_id: tools.form_template_id, body: tools.body }
      outputParameters: [{ type: object, mapping: $. }]