Farmers Edge client API
The client API from Farmers Edge — 7 operation(s) for client.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/farmers-edge-client-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: FarmCommand canplug Client API
termsOfService: https://www.farmcommand.com/terms-of-service
contact:
name: Product Support
email: productsupport@farmersedge.ca
version: '1.0'
servers:
- url: https://admin.farmcommand.com/
security:
- FarmCommand Token: []
tags:
- name: client
paths:
/client/forgotpassword/:
parameters: []
post:
operationId: client_forgotpassword_create
description: ''
responses:
'201':
description: ''
tags:
- client
/client/password/reset/:
parameters: []
post:
operationId: client_password_reset_create
description: Send an email to change a password with a token.
responses:
'201':
description: ''
content:
application/json:
schema:
required:
- identifier
- url
type: object
properties:
identifier:
description: The username or email of a user. Username is case sensitive.
type: string
url:
description: The url you would like used to reset the password with. /password/reset/<token> will be appended to the url passed in. eg. "https://admin.farmcommand.com"
type: string
'404':
description: Client not found
'400':
description: Bad request
tags:
- client
requestBody:
content:
application/json:
schema:
required:
- identifier
- url
type: object
properties:
identifier:
description: The username or email of a user. Username is case sensitive.
type: string
url:
description: The url you would like used to reset the password with. /password/reset/<token> will be appended to the url passed in. eg. "https://admin.farmcommand.com"
type: string
required: true
/client/password/reset/change/:
parameters: []
post:
operationId: client_password_reset_change_create
description: Change a password with a token.
responses:
'200':
description: Password changed successfully
'404':
description: Client not found
'400':
description: Bad request
tags:
- client
requestBody:
content:
application/json:
schema:
required:
- password
- token
type: object
properties:
token:
description: The token generated in the url
type: string
password:
description: The new password to change the users password to
type: string
required: true
/client/selfserveclient/:
parameters: []
post:
operationId: client_selfserveclient_create
summary: Create a new Self Serve Client
description: Create a new self-serve client.
parameters:
- name: token-login
in: query
description: Logs the user in and returns a token if set to true
schema:
type: boolean
responses:
'201':
description: Self Serve Client created
content:
application/json:
schema:
$ref: '#/components/schemas/SelfServeClientResponse'
'400':
description: Bad Request
'429':
description: Too Many Requests
tags:
- client
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SelfServeClient'
required: true
/client/selfserveclient/resend-verification-email:
parameters: []
post:
operationId: client_selfserveclient_resend-verification-email_create
description: Resend a verification email to a self-serve client.
responses:
'200':
description: Verification email sent successfully
'400':
description: Bad request
'404':
description: Self Serve Client not found
tags:
- client
requestBody:
content:
application/json:
schema:
required:
- email
type: object
properties:
email:
description: Email of the Self Serve Client
type: string
required: true
/client/selfserveclient/verify:
parameters: []
post:
operationId: client_selfserveclient_verify_create
description: Verify a self-serve client with a valid token.
responses:
'200':
description: Self Serve Client verified successfully
'400':
description: Bad request
'404':
description: Self Serve Client not found
tags:
- client
requestBody:
content:
application/json:
schema:
required:
- token
type: object
properties:
token:
description: The token sent in the verification email
type: string
required: true
/client/validate-username:
parameters: []
get:
operationId: client_validate-username_list
description: Validate the availability of a username.
parameters:
- name: username
in: query
description: The username to check for availability.
schema:
type: string
responses:
'200':
description: Username validated successfully.
content:
application/json:
schema:
type: object
properties:
available:
description: True if the specified username is valid and currently available, otherwise returns with error.
type: boolean
'400':
description: Bad Request.
tags:
- client
components:
schemas:
SelfServeClient:
required:
- username
- password
- first_name
- last_name
- email
- company_name
- phone
- postal_or_zip_code
- country
- client_type
type: object
properties:
id:
title: Id
type: integer
readOnly: true
user:
title: User
type: integer
username:
title: Username
type: string
minLength: 1
password:
title: Password
type: string
minLength: 1
first_name:
title: First name
type: string
minLength: 1
last_name:
title: Last name
type: string
minLength: 1
email:
title: Email
type: string
format: email
minLength: 1
product_name:
title: Product name
type: string
minLength: 1
company_name:
title: Company name
type: string
maxLength: 100
minLength: 1
partner:
title: Partner
type:
- string
- 'null'
enum:
- nsp
phone:
title: Phone
type: string
maxLength: 15
minLength: 1
address_line1:
title: Address line1
type:
- string
- 'null'
maxLength: 500
address_line2:
title: Address line2
type:
- string
- 'null'
maxLength: 500
city:
title: City
type:
- string
- 'null'
maxLength: 120
province_state:
title: Province state
type:
- string
- 'null'
maxLength: 100
postal_or_zip_code:
title: Postal or zip code
type: string
maxLength: 25
minLength: 1
country:
title: Country
type: string
enum:
- Canada
- USA
- Brazil
verified:
title: Verified
type: boolean
last_verification_email_sent:
title: Last verification email sent
type: string
format: date-time
readOnly: true
client_type:
title: Client type
type: string
enum:
- Grower
- Retailer
payment_session_id:
title: Payment session id
type: string
readOnly: true
minLength: 1
client_secret:
title: Client secret
type: string
readOnly: true
minLength: 1
payment_session_status:
title: Payment session status
type: string
enum:
- open
- complete
- expired
readOnly: true
eula_version:
title: Eula version
type:
- string
- 'null'
format: date
eula_date_signed:
title: Eula date signed
type: string
format: date-time
readOnly: true
crm_id:
title: Crm id
type: string
created_datetime:
title: Created datetime
type: string
format: date-time
readOnly: true
updated_datetime:
title: Updated datetime
type: string
format: date-time
readOnly: true
client:
title: Client
type:
- integer
- 'null'
service_offering:
title: Service offering
type: integer
readOnly: true
created_by:
title: Created by
type: integer
readOnly: true
last_updated_by:
title: Last updated by
type: integer
readOnly: true
SelfServeClientResponse:
required:
- username
- email
- first_name
- last_name
- company_name
- phone
- postal_or_zip_code
- country
- client_type
- user
type: object
properties:
id:
title: ID
type: integer
readOnly: true
username:
title: Username
type: string
minLength: 1
email:
title: Email
type: string
format: email
minLength: 1
first_name:
title: First name
type: string
minLength: 1
last_name:
title: Last name
type: string
minLength: 1
company_name:
title: Company name
type: string
maxLength: 100
minLength: 1
partner:
title: Partner
type:
- string
- 'null'
enum:
- nsp
phone:
title: Phone
type: string
maxLength: 15
minLength: 1
address_line1:
title: Address line1
type:
- string
- 'null'
maxLength: 500
address_line2:
title: Address line2
type:
- string
- 'null'
maxLength: 500
city:
title: City
type:
- string
- 'null'
maxLength: 120
province_state:
title: Province state
type:
- string
- 'null'
maxLength: 100
postal_or_zip_code:
title: Postal or zip code
type: string
maxLength: 25
minLength: 1
country:
title: Country
type: string
enum:
- Canada
- USA
- Brazil
verified:
title: Verified
type: boolean
last_verification_email_sent:
title: Last verification email sent
type:
- string
- 'null'
format: date-time
client_type:
title: Client type
type: string
enum:
- Grower
- Retailer
payment_session_id:
title: Payment session id
type: string
maxLength: 256
client_secret:
title: Client secret
type: string
maxLength: 512
payment_session_status:
title: Payment session status
type: string
enum:
- open
- complete
- expired
eula_version:
title: Eula version
type:
- string
- 'null'
format: date
eula_date_signed:
title: Eula date signed
type: string
format: date-time
crm_id:
title: Crm id
type: string
created_datetime:
title: Created datetime
type: string
format: date-time
readOnly: true
updated_datetime:
title: Updated datetime
type: string
format: date-time
readOnly: true
client:
title: Client
type:
- integer
- 'null'
user:
title: User
type: integer
service_offering:
title: Service offering
type:
- integer
- 'null'
created_by:
title: Created by
type:
- integer
- 'null'
last_updated_by:
title: Last updated by
type:
- integer
- 'null'
securitySchemes:
FarmCommand_Token:
type: apiKey
name: token
in: query