Equipment records can be used to keep track of any type of tool, machinery, utility location (wash station) or equipment that you want to store notes, photos, files and track maintenance and service records on. For example you could easily track cleaning and sanitization history for organic certification by creating an equipment record for a washing station.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/farmbrite:farmbrite-tools-equipment-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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: 3.2.0
info:
title: Farmbrite API Developers Documentation Tools & Equipment API
description: '# Overview
Welcome to the Farmbrite API. You can find out more about Farmbrite at
www.farmbrite.com
If you need help, check out our help center at help.farmbrite.com or email us at dev@farmbrite.com. ## API Reference
The Farmbrite API allows authorized users programatic access to their account data in order to facilitate the integration of this data with other systems and service. The API is organized around REST standards. The API uses resource-oriented URLs and returns JSON-encoded responses. It uses standard HTTP response codes, authentication, and verbs. > Base URL
```
https://api.farmbrite.com/v1
```
# Authentication
Farmbrite offers 2 authentication options for accessing the API both utilizing Personal Access Tokens (PATs) for enabling access to the API. Access Tokens (API Keys) are associated with an individual user in your account and inherit that user''s role and permissions. You can find the Access Token on the user profile page under API Key. When building an integration we recommend setting up a separate API user for the integration and changing the API KEY on a regular basis. Remember to keep your Access Tokens secret; treat them just like passwords! They act on your behalf when interacting with the API, with the same permissions and access as the user has. _Don''t hardcode them into your programs_. Instead, choose to store them as environment variables. ### Bearer Token
To make a request to the API include the Authorization Bearer header with your request and include your Access Token (API KEY) as the value. Access Token and API KEY are used interchangeably through out the documentation. > Example cURL request authenticating with Bearer Token authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "Authorization: Bearer ACCESS_TOKEN"
```
### API Key
Alternatively to using the Bearer Token authorization method, you can provide an API KEY as a header with your request. Use the header `api_key` with a value of your Access Token (API KEY). > Example cURL request authenticating with API Key header authentication
```
curl https://api.farmbrite.com/v1/tasks \
-H "api_key: ACCESS_TOKEN"
```
# Errors
Sadly, sometimes requests to the API fail. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code indicating the nature of the failure. | Code | Meaning | Description |
| --- | --- | --- |
| 200 | Success | The request was successful. If applicable the data it will be available in the data field at the top level of the response body. |
| 400 | Bad Request | Typically caused by a missing or malformed parameter. Check the documentation and your request and try again. |
| 401 | Unauthorized | No access token or an invalid access token was provided with the request. The error can also occur if the user or account is invalid or does not have access to this resource. |
| 403 | Forbidden | The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you access resources that the user or account does not have access to. |
| 404 | Not Found | Either the method and path supplied do not specify a known action or the object related to the request does not exist. |
| 429 | Too Many Requests | You have exceeded one of the rate limits in the API. See the Rate Limits section for more information. |
| 500 | Internal Server Error | There was a problem on Farmbrite''s side which was logged and reported to our technical team. You can retry, but if the problem continues please contact support. |
Details about errors can sometimes also be found in the ''message'' property at the root level of the JSON response body. # Pagination
In order to optimize performance, all list methods in the API will limit the total response data to a certain number of records and return the data in chunks (pages). API responses will include information about the total records available, the current page and total pages.'
version: 1.0.0
x-logo:
url: https://static.farmbrite.com/assets/www/images/logo.png
backgroundColor: '#FFFFFF'
altText: Farmbrite
termsOfService: https://www.farmbrite.com/terms
contact:
name: Farmbrite
url: https://developers.farmbrite.com
email: dev@farmbrite.com
servers:
- url: https://api.farmbrite.com/v1
security:
- bearerAuth: []
tags:
- name: Tools & Equipment
description: Equipment records can be used to keep track of any type of tool, machinery, utility location (wash station) or equipment that you want to store notes, photos, files and track maintenance and service records on. For example you could easily track cleaning and sanitization history for organic certification by creating an equipment record for a washing station.
paths:
/tools:
post:
tags:
- Tools & Equipment
summary: Create Tool or Equipment
description: 'Create equipment
### Parameters
**name** `REQUIRED`
The name or label for this piece of equipment
---
**amount** `OPTIONAL`
Numeric value representing the amount paid for the equipment, in the currency of your account.
---
**brand** `OPTIONAL`
Brand of equipment
---
**date_purchased** `OPTIONAL`
Date purchased
---
**description** `OPTIONAL`
Text description / summary of the equipment
---
**engine** `OPTIONAL`
Engine type (if applicable)
---
**manual_url** `OPTIONAL`
A valid web address / URL for the service manual
---
**model_number** `OPTIONAL`
Model number
---
**plate_number** `OPTIONAL`
License plate number (if applicable)
---
**purchased** `OPTIONAL`
Boolean value indicating if the item was purchased or not
---
**serial_number** `OPTIONAL`
Serial number
---
**electronic_id** `OPTIONAL`
Electronic ID - useful to set if using an RFID or barcode scanner to search for for sync data with Farmbrite.
---
**transmission** `OPTIONAL`
Transmission type (if applicable)
---
**type** `OPTIONAL`
Any string representing the type of equipment. For example: Tractor, harvester, cleaning station, feeder, etc.
---
**usage_unit** `OPTIONAL`
How do you track the usage of this equipment. Supported options are:
> "Hours", "Miles", "Kilometers"'
requestBody:
content:
application/json:
schema:
type: object
example:
amount: 28900
brand: Kubato
date_purchased: '2018-12-19'
description: Orange
engine: Kubato
manual_url: ''
model_number: M6060
name: Big Orange
plate_number: NA
purchased: false
serial_number: kjhfsdhu6546871
transmission: Kubato
type: Tractor
usage_unit: Hours
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: postTools
x-operation-id-source: derived
get:
tags:
- Tools & Equipment
summary: List Tools & Equipment
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
data:
- id: GUID
amount: 0
brand: Kubato
contact_id: Conact ID
created_at: '2016-11-21 23:59:12'
date_purchased: '2018-12-19'
description: Orange
engine: Kubato
manual_url: ''
mileage: 999
model_number: M6060
name: Big Orange
plate_number: NA
purchased: false
serial_number: kjhfsdhu6546871
transmission: Kubato
type: Tractor
updated_at: '2019-04-06 18:36:19'
usage_unit: Hours
operationId: getTools
x-operation-id-source: derived
/tools/{tool_id}:
get:
tags:
- Tools & Equipment
summary: Retrieve Equipment
parameters:
- name: tool_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
id: GUID
amount: 0
brand: Kubato
contact_id: Conact ID
created_at: '2016-11-21 23:59:12'
date_purchased: '2018-12-19'
description: Orange
engine: Kubato
manual_url: ''
mileage: 999
model_number: M6060
name: Big Orange
plate_number: NA
purchased: false
serial_number: kjhfsdhu6546871
transmission: Kubato
type: Tractor
updated_at: '2019-04-06 18:36:19'
usage_unit: Hours
operationId: getToolsByToolId
x-operation-id-source: derived
put:
tags:
- Tools & Equipment
summary: Update Equipment
requestBody:
content:
application/json:
schema:
type: object
example:
serial_number: 867-5309
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: tool_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putToolsByToolId
x-operation-id-source: derived
delete:
tags:
- Tools & Equipment
summary: Delete Equipment
parameters:
- name: tool_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: deleteToolsByToolId
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer