Skip to main content

OpenAPI And Tooling

OpenAPI Availability

Fieldkit exposes an OpenAPI spec for the Public API.

  • Public API OpenAPI JSON: https://api.fieldkit.cc/v3/api-docs/public-v1
  • Swagger UI: https://api.fieldkit.cc/swagger-ui.html

Suggested Near-Term Improvements

  1. Split specs by audience:
    • Internal platform API
    • Storefront/customer API
    • Future partner API
  2. Add operation tags and descriptions where missing.
  3. Generate SDKs/examples for the eventual public partner subset.