Skip to main content
Use these endpoints to attach provider credentials to a Leaf user. The base path is consistent, but the request body and supported helper endpoints vary by provider, so this page is best used as a path matrix rather than a single normalized contract. For setup requirements and request-body examples, see the provider-specific guides under Connecting Providers.

Base URL

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

Credential path matrix

ProviderCredential pathNotesDocumentation
John Deerejohn-deere-credentialsOAuth credentialsJohn Deere
CLAASclaas-credentialsOAuth with clientKey / clientSecret and grower refreshToken; clientEnvironment supports STAGE and PRODUCTIONCLAAS
Climate FieldViewclimate-field-view-credentialsOAuth credentialsClimate FieldView
CNHicnhi-credentialsRequires clientEnvironment in the request bodyCNHi
Trimbletrimble-credentialsOAuth credentialsTrimble
AgLeaderag-leader-credentialsUses app keys plus grower refresh tokenAgLeader
Starastara-credentialsUses apiKey, accessToken, accessTokenClient, and refreshTokenStara
Ravenraven-credentialsOAuth credentials for grower, farm, and field dataRaven
Raven Slingshotraven-slingshot-credentialsAPI key for machine file ingestionRaven Slingshot
Senterasentera-credentialsUsername/password credentialsSentera
AgVanceagvance-credentialsAPI key plus account credentialsAgVance
Panoramapanorama-credentialsPrecision Planting PanoramaPanorama
Lindsaylindsay-credentialsOAuth credentials with clientEnvironmentLindsay
Valleyvalley-credentialsAPI key plus account credentialsValley

Common path shape

The credential endpoints always start with the Leaf user:
/users/{leafUserId}/{credential-path}
Examples:
  • GET /users/{leafUserId}/john-deere-credentials
  • POST /users/{leafUserId}/ag-leader-credentials
  • DELETE /users/{leafUserId}/panorama-credentials
Most providers also expose a credential events endpoint:
/users/{leafUserId}/{credential-path}/events
Use the provider-specific documentation to confirm the exact request body and any provider-specific fields.

Example: get stored credentials

curl -X GET \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/john-deere-credentials'

Events endpoint

Many provider credential endpoints expose /events for troubleshooting authentication failures, token refreshes, and sync-related issues. When available, these endpoints support:
ParameterTypeDescription
pageintegerPage number (default 0)
sizeintegerPage size (default 20)
sortstringSort order such as createdDate,desc

What to do next

  • Use Connecting Providers to choose the right provider flow.
  • Use the provider-specific guides for request-body schemas and setup details.
  • Use Leaf users to create the Leaf user before attaching credentials.
Last modified on March 24, 2026