Places represent polygon shapes that are included on your farm map. They can be used to document grow locations, buildings, irrigation, animal enclosures, property boundaries or any other area you want to map. Places can be linked to grow locations, beds and warehouses.
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-mapped-places-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 Mapped Places 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: Mapped Places
description: Places represent polygon shapes that are included on your farm map. They can be used to document grow locations, buildings, irrigation, animal enclosures, property boundaries or any other area you want to map. Places can be linked to grow locations, beds and warehouses.
paths:
/places:
post:
tags:
- Mapped Places
summary: Create a Place
description: 'Create a place
### Parameters
**type** `REQUIRED`
The type of place. Standard options are:
* Property Boundary
* Animal Enclosure
* Bed
* Buffer Zone
* Building
* Field
* Growing Enclosure
* Irrigation
* Other
Custom options are also allowed
* * *
**title** `OPTIONAL`
The name or title for this mapped place. Required if not linking to a grow location, bed or warehouse.
* * *
**map_coords** `OPTIONAL`
A JSON stringified array of polygon / coordinate objects, each including a lat and lng value.
For example:
`"[{"lat":40.200893095255765,"lng":-105.17513049468994},{"lat":40.2006964261442,"lng":-105.17536652908325},{"lat":40.20045468624636,"lng":-105.17511976585388},{"lat":40.200606285944076,"lng":-105.17487300262451}]"`
* * *
**sqft** `OPTIONAL`
A numeric value for the square feet of the area being mapped. This is used for calculating planting area if linked to a grow location or bed.
* * *
**z_index** `OPTIONAL`
A numeric value indicating the z-index or layer position of the mapped polygon.
* * *
**color** `OPTIONAL`
A hex value for the color of the polygon, including the #.
For example: `''#000000''` would be a black polygon.
If blank and specificity a standard place type a default color will be set.
* * *
**plot_id** `OPTIONAL`
The grow location id this place belongs to if, if applicable. **Required** if providing a bed id.
* * *
**bed_id** `OPTIONAL`
The bed id this place belongs to if, if applicable.
* * *
**warehouse_id** `OPTIONAL`
The warehouse id this place belongs to if, if applicable.
* * *'
requestBody:
content:
application/json:
schema:
type: object
example:
color: '#000000'
map_coords: '[{"lat":40.200893095255765,"lng":-105.17513049468994},{"lat":40.2006964261442,"lng":-105.17536652908325},{"lat":40.20045468624636,"lng":-105.17511976585388},{"lat":40.200606285944076,"lng":-105.17487300262451}]'
sqft: 10968
title: From API
type: Animal Enclosure
z_index: 1
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: postPlaces
x-operation-id-source: derived
get:
tags:
- Mapped Places
summary: List Places
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
data:
- id: GUID
bed_id: null
color: null
created_at: '2022-04-07 18:44:05'
map_coords: '[{"lat":40.200893095255765,"lng":-105.17513049468994},{"lat":40.2006964261442,"lng":-105.17536652908325},{"lat":40.200606285944076,"lng":-105.17487300262451}]'
plot_id: null
sqft: 6026
title: Animal Enclosure
type: Animal Enclosure
updated_at: '2022-04-07 18:44:05'
warehouse_id: null
z_index: 1
operationId: getPlaces
x-operation-id-source: derived
/places/{place_id}:
get:
tags:
- Mapped Places
summary: Retrieve a Place
parameters:
- name: place_id
in: path
schema:
type: string
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
id: PLACE ID
bed_id: null
color: '#000000'
created_at: '2022-05-11 22:28:49'
map_coords: '[{"lat":40.200893095255765,"lng":-105.17513049468994},{"lat":40.2006964261442,"lng":-105.17536652908325},{"lat":40.20045468624636,"lng":-105.17511976585388},{"lat":40.200606285944076,"lng":-105.17487300262451}]'
plot_id: null
sqft: 10968
title: From API
type: Animal Enclosure
updated_at: '2022-05-11 22:29:19'
warehouse_id: null
z_index: 1
operationId: getPlacesByPlaceId
x-operation-id-source: derived
put:
tags:
- Mapped Places
summary: Update a Place
requestBody:
content:
application/json:
schema:
type: object
example:
title: Updated from API
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: place_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: putPlacesByPlaceId
x-operation-id-source: derived
delete:
tags:
- Mapped Places
summary: Delete a Place
parameters:
- name: place_id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
operationId: deletePlacesByPlaceId
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer