Fieldproxy

Fieldproxy API

Fieldproxy API as documented publicly: 17 operations. Contract generated from the documentation by API Evangelist (2026-10-27); not the provider's own document.

GitHub OpenAPI

Operations 17

POST / POST / #
PUT /api/customers Full API access, real-time webhooks, and flexible export options RESTful API #
POST /api/delete POST /api/delete #
GET /api/equipment Full API access, real-time webhooks, and flexible export options RESTful API #
POST /api/insert POST /api/insert #
POST /api/jobs Full API access, real-time webhooks, and flexible export options RESTful API #
POST /api/read POST /api/read #
POST /api/update POST /api/update #
POST /auth/org POST /auth/org #
GET /automation/hooks/{workspaceId}/{ruleId} Call automation webhook #
GET /public-forms Public forms and links #
POST /public-forms Public forms and links #
GET /public-forms/{id}/check Public forms and links #
POST /public-forms/{id}/links Public forms and links #
POST /public-forms/{id}/links/{linkid}/revoke Public forms and links #
POST /public-forms/{id}/publish Public forms and links #
GET /public-forms/{id}/submissions Public forms and links #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/fieldproxy-ai/openapi/_ae-authored/fieldproxy-ai-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-api-read-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-auth-org-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-api-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-api-insert-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-api-delete-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/fieldproxy-ai/json-schema/fieldproxy-ai-post-api-read-request-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/fieldproxy-ai/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/fieldproxy-ai:fieldproxy-ai-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fieldproxy-ai-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Fieldproxy API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 17 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Fieldproxy has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 11
    pages-with-code: 4
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.fieldproxy.ai/developers/docs/rest-api
  - https://www.fieldproxy.ai/developers
  - https://www.fieldproxy.ai/developers/llms.txt
  - https://www.fieldproxy.ai/developers/openapi.json
  - https://www.fieldproxy.ai/developers/docs/webhooks-automations
  - https://www.fieldproxy.ai/developers/docs
  - https://www.fieldproxy.ai/developers/capabilities.json
  - https://www.fieldproxy.ai/developers/docs/public-forms
  - https://www.fieldproxy.ai/platform/databases
servers:
- url: https://api-india-1.fieldproxy.ai
paths:
  /:
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://www.fieldproxy.ai/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Copy curl -X POST "https://<api-host>/automation/hooks/<workspace-id>/<rule-id>"  -H "Content-Type: application/json"  -H
          "x-automation-secret: <your-shared-secret>"  -d ''{"name": "Dana Lee", "phone": "+15550100", "issue": "No cooling, unit 4B"}'''
  /api/customers:
    put:
      operationId: put_api_customers
      tags:
      - Api
      summary: Full API access, real-time webhooks, and flexible export options RESTful API
      x-source: https://www.fieldproxy.ai/platform/databases
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/delete:
    post:
      operationId: post_api_delete
      tags:
      - Api
      summary: POST /api/delete
      x-source: https://www.fieldproxy.ai/developers/docs/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDeleteRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api-india-1.fieldproxy.ai/api/delete  -H "x-api-key: $FIELDPROXY_API_KEY"  -H "content-type: application/json"  -d
          ''{"tableName": "your_table", "condition": {"id": 2}}'''
  /api/equipment:
    get:
      operationId: get_api_equipment
      tags:
      - Api
      summary: Full API access, real-time webhooks, and flexible export options RESTful API
      x-source: https://www.fieldproxy.ai/platform/databases
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/insert:
    post:
      operationId: post_api_insert
      tags:
      - Api
      summary: POST /api/insert
      x-source: https://www.fieldproxy.ai/developers/docs/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiInsertRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api-india-1.fieldproxy.ai/api/insert  -H \"x-api-key: $FIELDPROXY_API_KEY\"  -H \"content-type: application/json\"\
          \  -d '{\"tableName\": \"your_table\",\n \"data\": [\n {\"name\": \"Gamma\", \"status\": \"open\", \"qty\": 1},\n {\"name\": \"Delta\"\
          , \"status\": \"closed\", \"qty\": 9}\n ]}'"
  /api/jobs:
    post:
      operationId: post_api_jobs
      tags:
      - Api
      summary: Full API access, real-time webhooks, and flexible export options RESTful API
      x-source: https://www.fieldproxy.ai/platform/databases
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/read:
    post:
      operationId: post_api_read
      tags:
      - Api
      summary: POST /api/read
      x-source: https://www.fieldproxy.ai/developers/docs/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiReadRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiReadResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api-india-1.fieldproxy.ai/api/read  -H "x-api-key: $FIELDPROXY_API_KEY"  -H "content-type: application/json"  -d
          ''{"tableName": "your_table", "condition": {"id": 1}}'''
  /api/update:
    post:
      operationId: post_api_update
      tags:
      - Api
      summary: POST /api/update
      x-source: https://www.fieldproxy.ai/developers/docs/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUpdateRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api-india-1.fieldproxy.ai/api/update  -H \"x-api-key: $FIELDPROXY_API_KEY\"  -H \"content-type: application/json\"\
          \  -d '{\"tableName\": \"your_table\",\n \"condition\": {\"status\": \"open\"},\n \"data\": {\"status\": \"closed\", \"qty\": 7}}'"
  /auth/org:
    post:
      operationId: post_auth_org
      tags:
      - Auth
      summary: POST /auth/org
      x-source: https://www.fieldproxy.ai/developers/docs/rest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAuthOrgRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAuthOrgResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api.fieldproxy.ai/auth/org  -H "content-type: application/json"  -d ''{"orgid": "<workspace-id>"}'''
  /automation/hooks/{workspaceId}/{ruleId}:
    get:
      operationId: get_automation_hooks_workspaceId_ruleId
      tags:
      - Automation
      summary: Call automation webhook
      description: Triggers an automation rule via its inbound webhook; returns 202 with an accepted flag.
      x-source: https://www.fieldproxy.ai/developers
      parameters:
      - name: workspaceId
        in: path
        required: true
        schema:
          type: string
      - name: ruleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAutomationHooksWorkspaceidRuleidResponse'
      x-evidence:
        kind: documentation
  /public-forms:
    get:
      operationId: get_public_forms
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_public_forms
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /public-forms/{id}/check:
    get:
      operationId: get_public_forms_id_check
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /public-forms/{id}/links:
    post:
      operationId: post_public_forms_id_links
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /public-forms/{id}/links/{linkid}/revoke:
    post:
      operationId: post_public_forms_id_links_linkid_revoke
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: linkid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /public-forms/{id}/publish:
    post:
      operationId: post_public_forms_id_publish
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /public-forms/{id}/submissions:
    get:
      operationId: get_public_forms_id_submissions
      tags:
      - Public Forms
      summary: Public forms and links
      x-source: https://www.fieldproxy.ai/developers/docs/public-forms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostRequest:
      type: object
      properties:
        name:
          type: string
        phone:
          type: string
        issue:
          type: string
    PostApiDeleteRequest:
      type: object
      properties:
        tableName:
          type: string
        condition:
          type: object
          properties:
            id:
              type: integer
    PostApiInsertRequest:
      type: object
      properties:
        tableName:
          type: string
        data:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              status:
                type: string
              qty:
                type: integer
    PostApiReadRequest:
      type: object
      properties:
        tableName:
          type: string
        condition:
          type: object
          properties:
            id:
              type: integer
    PostApiReadResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              status:
                type: string
              qty:
                type: integer
              created_at:
                type: string
                format: date-time
              updated_at:
                type: string
                format: date-time
        rowCount:
          type: integer
        table:
          type: string
        tenant:
          type: string
    PostApiUpdateRequest:
      type: object
      properties:
        tableName:
          type: string
        condition:
          type: object
          properties:
            status:
              type: string
        data:
          type: object
          properties:
            status:
              type: string
            qty:
              type: integer
    PostAuthOrgRequest:
      type: object
      properties:
        orgid:
          type: string
    PostAuthOrgResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              status:
                type: string
              qty:
                type: integer
              created_at:
                type: string
                format: date-time
              updated_at:
                type: string
                format: date-time
        rowCount:
          type: integer
        table:
          type: string
        tenant:
          type: string
    GetAutomationHooksWorkspaceidRuleidResponse:
      type: object
      properties:
        accepted:
          type: boolean
          description: True if the rule was accepted for background processing
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Api
- name: Auth
- name: Automation
- name: Public Forms