Global FieldID UIMy AccountSupportRoadmap
Guides

Introduction to Global FieldID™ API

The Global FieldID API enables applications to integrate with the Global FieldID System

Suggest Edits

Summary of API Functions

Lookup

POST /field-searchesSearches for Global FieldIDs in a given geometry, enabling third party applications to annotate their fields with the best Global FieldID match. See FieldID Lookups.
GET /boundariesReturns a collection of boundaries applying spatial or metadata filtering.
GET /boundary-referencesSearches for external IDs of boundaries registered in the system. This enables Global FieldID to be used as a cross-referencing system for spatial data.

Get by ID

GET /fields/{id}Returns a field object, including the ID of the boundary that defines the field's spatial extent.
GET /boundaries/{id}The returned GeoJSON object includes the boundary's geometry and spatial properties.
GET /fields/{id}/boundariesFetches the boundaries associated with a given field over time (namely those used to define its spatial extent).
GET /boundary-references/{id}Returns metadata about a boundary according to a specific system, using Varda's unique ID.

Create

POST /fieldsCreates a new field in the 'public' map of fields using a boundary geometry. It can also be used to replace an existing field with a new ID when significant changes are made. See Creating fields .
POST /boundariesRegisters a boundary geometry thus obtaining a canonical ID. It can be used for any boundary/shape, not only for a canonical field boundary. See Custom shapes.

Update

PATCH /fields/{id}Updates a field with a 'better' boundary whilst retaining the same Global FieldID. See Boundary replacement.
PATCH /boundary-references/{id}/permissionsUpdates private boundary's discoverability and access by other users. See updating permissions.

Delete

DELETE /fields/{id}Removes a field from the map retaining its history. See Deleting a field.

How do I access the API?

The API uses the OAuth 2.0 client credentials flow to authenticate requests. API access is self-serviced through our Account Hub (you will be asked to create a user account or sign in).

Refer to How to create a M2M app page for a step-by-step guide.

Deep dive on Global FieldID concepts

Updated 3 months ago