Integrations Endpoints

All HTTP methods should be prepended by this service's endpoint:

https://api.withleaf.io/services/integrations/api

This service has the following endpoints available:

DescriptionEndpoints
Get Integrations ResourcesGET /resources

For easy testing of these endpoints, we recommend using our Postman collection.

To understand how to verify if an incoming request comes from Leaf, see the Authentication section.


Get Integrations Resources

ย GET /resources

Gets a paged list of Fields. It is possible to filter the results by passing some query parameters.

  • provider, only matches fields from this provider (string).
  • leafUserId, only matches fields from this user (string).
  • page, an integer specifying the page being fetched.
  • size, an integer specifying the size of the page (defaults to 20).

These last two parameters are used exclusively for paging through results.

Request examples

curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/integrations/api/resources'

Response

{
"message": "SUCCESS",
"summaries": [
{
"provider": "JohnDeere",
"leafUserId": "UUID",
"growers": 12,
"farms": 12,
"fields": 100,
"syncReferenceTime": "2023-08-30T18:39:33.230612Z"
},
{
"provider": "ClimateFieldView",
"leafUserId": "UUID",
"farms": 12,
"fields": 100,
"syncReferenceTime": "2023-08-30T18:39:33.230612Z"
},
....
]
}
FMIS Structure Warning

Each provider has its own implementation of the FMIS structure which you can check on the table below.

FMIS Structure Table

This table contains the FMIS properties available for the Integrations Resources responses.

ProviderGrowerFarmField
JohnDeereโœ…โœ…โœ…
ClimateFieldViewโœ–๏ธโœ…โœ…
CNHIโœ…โœ…โœ…
Trimbleโœ…โœ…โœ…
Staraโœ–๏ธโœ–๏ธโœ…
Ravenโœ…โœ…โœ…
AgVanceโœ…โœ…โœ…