Farmbrite Animals & Livestock > Grazings / Movements API

openapi: 3.2.0
info:
  title: Farmbrite API Developers Documentation Animals & Livestock…
  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: Animals & Livestock > Grazings / Movements
  description: 'Grazing records track the grazing history of animals or livestock groups. You can access grazings for resources:


    - Livestock `/animals`

    - Livestock Groups `/livestock_groups`


    To move an animal or livestock group to a different grazing location simply append ''/grazings'' to the end of the resource path. For example: \[POST\] /animals/:animal_id/grazings to move the animal and create a new grazing record.


    When an animal is moved to a new location the prior grazing record will be also automatically updated to indicated the animal left that location.'
paths:
  /{resource_name}/{resource_id}/grazings:
    post:
      tags:
      - Animals & Livestock > Grazings / Movements
      summary: Create Grazing (Move Animal/Group)
      description: 'Move an animal or livestock group grazing location


        ### Parameters


        **location_id** `REQUIRED`


        The ID of the `grow_location` to move the animal or livestock group to


        * * *


        **date** `OPTIONAL`


        The date of the change in location. Defaults to today.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                location_id: Grow Location ID
                date: '2022-01-20'
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: resource_name
        in: path
        schema:
          type: string
        required: true
        description: animals or livestock_groups
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
        description: animal id or livestock_group id
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postByResourceNameByResourceIdGrazings
      x-operation-id-source: derived
  /grazings:
    get:
      tags:
      - Animals & Livestock > Grazings / Movements
      summary: Grazing Summary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - location_id: Grow Location ID
                  location_name: Grow Location Name
                  days_rested: null
                  animal_count: 99
                  rest_days: null
                  grazing_status: null
                  avg_days: 45
                  min_start_date: '2022-01-01 00:00:00'
                  max_start_date: '2023-02-03 00:00:00'
                  last_grazed: null
      operationId: getGrazings
      x-operation-id-source: derived
  /animals/{animal_id}/grazings:
    get:
      tags:
      - Animals & Livestock > Grazings / Movements
      summary: List Animal Grazings
      parameters:
      - name: animal_id
        in: path
        schema:
          type: string
        required: true
        example: '{{animal_id}}'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: 68fbcfb81f4647c0aa2dc24b
                  animal_count: 1
                  animal_id: 5675e5ef38221cf69e000007
                  animal_type: cow
                  au: 0.8
                  created_at: '2025-10-24 19:12:57'
                  created_by: User
                  end_date: '2025-10-27'
                  place_id: null
                  plot_id: 58272c7a38221c7802000001
                  start_date: '2025-10-31'
                  updated_at: '2025-10-24 19:12:57'
                  weight: 4001
      operationId: getAnimalsByAnimalIdGrazings
      x-operation-id-source: derived
  /animals/{animal_id}/grazings/{id}:
    get:
      tags:
      - Animals & Livestock > Grazings / Movements
      summary: Retrieve Animal Grazing Record
      parameters:
      - name: animal_id
        in: path
        schema:
          type: string
        required: true
        example: '{{animal_id}}'
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: grazing record id OR current to get animal current location
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 68ffb276243e9af01b981e3b
                animal_count: 1
                animal_id: 5675e5ef38221cf69e000007
                animal_type: cow
                au: 0.8
                created_at: '2026-10-27 17:57:10'
                created_by: User
                end_date: null
                place_id: null
                plot_id: 66ff132867733d00090d065c
                start_date: '2026-10-27'
                updated_at: '2026-10-27 17:57:10'
                weight: 800
      operationId: getAnimalsByAnimalIdGrazingsById
      x-operation-id-source: derived
  /animals/{animal_id}/grazings/current:
    get:
      tags:
      - Animals & Livestock > Grazings / Movements
      summary: Retrieve Animal's Current Location
      parameters:
      - name: animal_id
        in: path
        schema:
          type: string
        required: true
        example: '{{animal_id}}'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: 68ffb276243e9af01b981e3b
                animal_count: 1
                animal_id: 5675e5ef38221cf69e000007
                animal_type: cow
                au: 0.8
                created_at: '2026-10-27 17:57:10'
                created_by: User
                end_date: null
                place_id: null
                plot_id: 66ff132867733d00090d065c
                start_date: '2026-10-27'
                updated_at: '2026-10-27 17:57:10'
                weight: 800
      operationId: getAnimalsByAnimalIdGrazingsCurrent
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer