SoilOptix

SoilOptix Fields API

Fields are attached directly to a Farm and provide a level of organization within a Farm. When requesting the Boundary of a Field, the Boundary of the active Analysis for this Field will be returned. (**Tip:** You can modify an Analysis to mark it as the active Analysis).

Documentation GitHub OpenAPI

Operations 5

GET /api/v4/fields/ Work with data related to your fields #

POST /api/v4/fields/ Create a new field #

GET /api/v4/fields/{field_id} Work with data related to your field #

PATCH /api/v4/fields/{field_id} Update your existing field #

DELETE /api/v4/fields/{field_id} Delete your existing field #

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/soiloptix:soiloptix-fields-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

openapi: 3.2.0
info:
  title: SoilOptix Client Fields API
  version: '1.0'
  description: Service to retrieve data from SoilOptix Db for Clients portal
  termsOfService: https://soiloptix.com/terms-of-service/
  contact:
    name: Get Help with this API
    url: http://www.soiloptix.com
    email: dev@soiloptix.com
    copyright: SoilOptix 2022-2025
tags:
- name: Fields
  description: Fields are attached directly to a Farm and provide a level of organization within a Farm. When requesting the Boundary of a Field, the Boundary of the active Analysis for this Field will be returned. (**Tip:** You can modify an Analysis to mark it as the active Analysis).
paths:
  /api/v4/fields/:
    get:
      tags:
      - Fields
      summary: Work with data related to your fields
      operationId: get_fields_api_v4_fields__get
      security:
      - Authorization: []
      parameters:
      - name: filterByFarm
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to fields found under this Farm Id
          title: Filterbyfarm
        description: Limit results to fields found under this Farm Id
      - name: filterByBusiness
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to fields found under this Business Id
          title: Filterbybusiness
        description: Limit results to fields found under this Business Id
      - name: filterByBusinessRecursive
        in: query
        required: false
        schema:
          type: integer
          exclusiveMinimum: 0
          description: Limit results to fields found under this Business Id and it's child businesses
          title: Filterbybusinessrecursive
        description: Limit results to fields found under this Business Id and it's child businesses
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FieldRelationEnum'
          description: Include additional relations to the entity
          default: []
          title: Include
        description: Include additional relations to the entity
      - name: sortBy
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/FieldSortByEnum'
      - name: searchName
        in: query
        required: false
        schema:
          type: string
          maxLength: 128
          default: ''
          title: Searchname
      - name: beforeDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data before this date (YYYY-MM-DD)
          title: Beforedate
        description: Return data before this date (YYYY-MM-DD)
      - name: afterDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data after this date (YYYY-MM-DD)
          title: Afterdate
        description: Return data after this date (YYYY-MM-DD)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Page size
          default: 5
          title: Limit
        description: Page size
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Current page, starts from 0
          default: 0
          title: Page
        description: Current page, starts from 0
      - name: sortAsc
        in: query
        required: false
        schema:
          type: boolean
          description: Sort direction, ascending if true
          default: true
          title: Sortasc
        description: Sort direction, ascending if true
      - name: returnEnum
        in: query
        required: false
        schema:
          type: boolean
          description: Return short entity version, containing only Id and Name
          default: false
          title: Returnenum
        description: Return short entity version, containing only Id and Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  anyOf:
                  - $ref: '#/components/schemas/Field'
                  - $ref: '#/components/schemas/EnumEntity'
                title: Response Get Fields Api V4 Fields  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Fields
      summary: Create a new field
      operationId: create_field_api_v4_fields__post
      security:
      - Authorization: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/fields/{field_id}:
    get:
      tags:
      - Fields
      summary: Work with data related to your field
      operationId: get_field_api_v4_fields__field_id__get
      security:
      - Authorization: []
      parameters:
      - name: field_id
        in: path
        required: true
        schema:
          type: integer
          title: Field Id
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/FieldRelationEnum'
          description: Include additional relations to the entity
          default: []
          title: Include
        description: Include additional relations to the entity
      - name: sortBy
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/FieldSortByEnum'
      - name: searchName
        in: query
        required: false
        schema:
          type: string
          maxLength: 128
          default: ''
          title: Searchname
      - name: beforeDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data before this date (YYYY-MM-DD)
          title: Beforedate
        description: Return data before this date (YYYY-MM-DD)
      - name: afterDate
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Return data after this date (YYYY-MM-DD)
          title: Afterdate
        description: Return data after this date (YYYY-MM-DD)
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: Page size
          default: 5
          title: Limit
        description: Page size
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          description: Current page, starts from 0
          default: 0
          title: Page
        description: Current page, starts from 0
      - name: sortAsc
        in: query
        required: false
        schema:
          type: boolean
          description: Sort direction, ascending if true
          default: true
          title: Sortasc
        description: Sort direction, ascending if true
      - name: returnEnum
        in: query
        required: false
        schema:
          type: boolean
          description: Return short entity version, containing only Id and Name
          default: false
          title: Returnenum
        description: Return short entity version, containing only Id and Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Fields
      summary: Update your existing field
      operationId: update_field_api_v4_fields__field_id__patch
      security:
      - Authorization: []
      parameters:
      - name: field_id
        in: path
        required: true
        schema:
          type: integer
          title: Field Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Fields
      summary: Delete your existing field
      operationId: delete_field_api_v4_fields__field_id__delete
      security:
      - Authorization: []
      parameters:
      - name: field_id
        in: path
        required: true
        schema:
          type: integer
          title: Field Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CustomerBusinessRelationship:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        Email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        IsAdmin:
          type: boolean
          title: Isadmin
          default: false
        IsSubscribed:
          type: boolean
          title: Issubscribed
          default: false
      type: object
      required:
      - Id
      title: CustomerBusinessRelationship
    Invite:
      properties:
        Id:
          type: integer
          title: Id
        Email:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
        InvitedAsAdmin:
          type: boolean
          title: Invitedasadmin
        Business:
          $ref: '#/components/schemas/BusinessPublic'
      type: object
      required:
      - Id
      - InvitedAsAdmin
      title: Invite
    FieldUpdate:
      properties:
        Name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
        CountryId:
          type: integer
          title: Countryid
        FarmId:
          type: integer
          title: Farmid
      type: object
      title: FieldUpdate
    FieldSortByEnum:
      type: string
      enum:
      - Id
      - Name
      - CreatedOn
      - CountryId
      title: FieldSortByEnum
    Model:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          type: string
          title: Name
        Resolution:
          type: number
          title: Resolution
        PublishedDate:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Publisheddate
      type: object
      required:
      - Id
      - Name
      - Resolution
      - PublishedDate
      title: Model
    FieldRelationEnum:
      type: string
      enum:
      - Analyses
      - Boundary
      - Farm
      - Country
      - Status
      title: FieldRelationEnum
    BusinessPublic:
      properties:
        Name:
          type: string
          title: Name
        ContactName:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactname
        ContactEmail:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactemail
        Phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        Address:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Address
        City:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: City
        PostalCode:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Postalcode
        ProvinceState:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Provincestate
        CountryId:
          type: integer
          title: Countryid
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        Id:
          type: integer
          title: Id
      type: object
      required:
      - Name
      - CountryId
      - Id
      title: BusinessPublic
    AnalysisPackage:
      properties:
        PackageId:
          type: integer
          title: Packageid
        PackageName:
          type: string
          title: Packagename
        IsSelected:
          type: boolean
          title: Isselected
      type: object
      required:
      - PackageId
      - PackageName
      - IsSelected
      title: AnalysisPackage
    FieldCreate:
      properties:
        Name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
        CountryId:
          type: integer
          title: Countryid
        FarmId:
          type: integer
          title: Farmid
      type: object
      required:
      - Name
      - CountryId
      - FarmId
      title: FieldCreate
    Analysis:
      properties:
        Name:
          type: string
          title: Name
        FieldId:
          type: integer
          title: Fieldid
        Id:
          type: integer
          title: Id
        LastUpdated:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Lastupdated
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        AreaSquareM:
          anyOf:
          - type: number
          - type: 'null'
          title: Areasquarem
        IsActive:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Isactive
        Resample:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Resample
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Farm:
          anyOf:
          - $ref: '#/components/schemas/Farm'
          - type: 'null'
        Field:
          anyOf:
          - $ref: '#/components/schemas/Field'
          - type: 'null'
        Models:
          items:
            $ref: '#/components/schemas/Model'
          type: array
          title: Models
        Boundary:
          anyOf:
          - type: string
          - type: 'null'
          title: Boundary
        Status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        Packages:
          anyOf:
          - items:
              $ref: '#/components/schemas/AnalysisPackage'
            type: array
          - type: 'null'
          title: Packages
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
        CanModifyBillable:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodifybillable
      type: object
      required:
      - Name
      - FieldId
      - Id
      title: Analysis
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Field:
      properties:
        Name:
          type: string
          title: Name
        CountryId:
          type: integer
          title: Countryid
        FarmId:
          type: integer
          title: Farmid
        Id:
          type: integer
          title: Id
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        Farm:
          anyOf:
          - $ref: '#/components/schemas/Farm'
          - type: 'null'
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        Analyses:
          items:
            $ref: '#/components/schemas/Analysis'
          type: array
          title: Analyses
        Boundary:
          anyOf:
          - type: string
          - type: 'null'
          title: Boundary
        Status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - FarmId
      - Id
      title: Field
    EnumEntity:
      properties:
        Id:
          type: integer
          title: Id
        Name:
          type: string
          title: Name
      type: object
      required:
      - Id
      - Name
      title: EnumEntity
    Farm:
      properties:
        Name:
          type: string
          title: Name
        CountryId:
          type: integer
          title: Countryid
        BusinessId:
          type: integer
          title: Businessid
        Id:
          type: integer
          title: Id
        CreatedOn:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdon
        Business:
          anyOf:
          - $ref: '#/components/schemas/Business'
          - type: 'null'
        Fields:
          anyOf:
          - items:
              $ref: '#/components/schemas/Field'
            type: array
          - type: 'null'
          title: Fields
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        Area:
          type: number
          title: Area
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - BusinessId
      - Id
      title: Farm
    Business:
      properties:
        Name:
          type: string
          title: Name
        ContactName:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactname
        ContactEmail:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Contactemail
        Phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        Address:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Address
        City:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: City
        PostalCode:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Postalcode
        ProvinceState:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Provincestate
        CountryId:
          type: integer
          title: Countryid
        BusinessTypeId:
          type: integer
          title: Businesstypeid
          default: 1
        Id:
          type: integer
          title: Id
        ParentBusinesses:
          anyOf:
          - items:
              $ref: '#/components/schemas/BusinessPublic'
            type: array
          - type: 'null'
          title: Parentbusinesses
        Customers:
          anyOf:
          - items:
              $ref: '#/components/schemas/CustomerBusinessRelationship'
            type: array
          - type: 'null'
          title: Customers
        Invites:
          anyOf:
          - items:
              $ref: '#/components/schemas/Invite'
            type: array
          - type: 'null'
          title: Invites
        Farms:
          anyOf:
          - items:
              $ref: '#/components/schemas/Farm'
            type: array
          - type: 'null'
          title: Farms
        Country:
          anyOf:
          - $ref: '#/components/schemas/EnumEntity'
          - type: 'null'
        ChildBusinesses:
          anyOf:
          - items:
              $ref: '#/components/schemas/BusinessPublic'
            type: array
          - type: 'null'
          title: Childbusinesses
        ContractId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Contractid
        ZCTTemplates:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Zcttemplates
        CreatedOn:
          type: string
          format: date-time
          title: Createdon
        CanModify:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Canmodify
      type: object
      required:
      - Name
      - CountryId
      - Id
      - CreatedOn
      title: Business
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer