Farmbrite Animals & Livestock > Feedings 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 > Feedings
  description: 'Feedings are embedded resources that are used by a variety of core resources. You can access feedings for resources:


    - Livestock `/animals`

    - Livestock Groups `/livestock_groups`


    To create or access feedings for a record, simply append ''/feedings'' to the end of the resource path. For example: \[GET\] /animals/:animal_id/feedings will fetch the records for the animal (based on the id provided).'
paths:
  /{resource_name}/{resource_id}/feedings:
    post:
      tags:
      - Animals & Livestock > Feedings
      summary: Create a Feeding
      description: 'Create a feeding record


        ### Parameters


        **amount** `REQUIRED`


        Numeric value representing the amount fed in the unit provided or a compatible unit of the inventory type (if supplying an `inventory_id`)


        ---


        **cost** `OPTIONAL`


        Cost of feeding, this will be automatically calculated if supplying an `inventory_id`


        ---


        **date** `OPTIONAL`


        The date of the feeding. Defaults to today - formatted as `YYYY-MM-DD`


        ---


        **description** `OPTIONAL`


        Description of the feeding


        ---


        type `OPTIONAL`


        Feeding details. For example feed type. `Required if not providing inventory id`


        ---


        **inventory_id** `OPTIONAL`


        The Farmbrite ID for the inventory record to associate with this feeding. If supplied Farmbrite will try to deduct the amount of the feeding from the inventory. `Required if not providing feeding type`


        ---


        **inventory_location_id** `OPTIONAL`


        The location of the inventory to use. This can be found by querying the inventory type inventory, see location_id in response that matches with the location you want to use - eg; warehouse and bin combination. Required when supplying an `inventory_id`


        ---


        **unit** `OPTIONAL`


        The unit of the feeding. If supplying an `inventory_id` this must be compatible with the inventory units. Support values are:


        > "Quantity", "Ounces", "Pounds", "Tons", "Grams", "Kilograms", "Tonnes"


        ---


        **per_head** `OPTIONAL`


        Boolean value used when creating a feeding for a livestock group. If `true` will create a duplicate feeding for each animal in the group using the values you provide. If set to `false` will split the amount evenly across each animal in the group.


        Defaults to `false`'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                amount: 10
                cost: 15
                date: '2026-07-01'
                description: API Feeding
                type: Feeding details (Required if not providing inventory id)
                inventory_id: Inventory ID (Required if not providing type)
                inventory_location_id: Inventory Location ID (Required if not inventory_id)
                unit: pounds
                per_head: false
      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
        example: '{{resource_name}}'
      - name: resource_id
        in: path
        schema:
          type: string
        required: true
        description: animal id or livestock group id
        example: '{{animal_id}}'
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postByResourceNameByResourceIdFeedings
      x-operation-id-source: derived
    get:
      tags:
      - Animals & Livestock > Feedings
      summary: List Feedings
      parameters:
      - 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: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: GUID
                  amount: 100
                  animal_count: null
                  cost: 200
                  created_at: '2022-03-09 23:23:44'
                  created_by: User
                  date: '2022-03-09'
                  description: ''
                  group_id: null
                  inventory_amount: 2
                  inventory_id: Inventory ID
                  inventory_location_id: Inventory Location ID
                  inventory_lot_id: Inventory Lot ID
                  parent_id: null
                  per_head: null
                  type: ''
                  unit: pounds
                  updated_at: '2022-03-09 23:23:44'
                  weight: 100
      operationId: getByResourceNameByResourceIdFeedings
      x-operation-id-source: derived
  /{resource_name}/{resource_id}/feedings/{feeding_id}:
    get:
      tags:
      - Animals & Livestock > Feedings
      summary: Retrieve a Feeding
      parameters:
      - 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
      - name: feeding_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: GUID
                amount: 100
                animal_count: null
                cost: 200
                created_at: '2022-03-20 19:15:25'
                created_by: User
                date: '2022-03-20'
                description: API Feeding
                group_id: null
                inventory_amount: 2
                inventory_id: Inventory ID
                inventory_location_id: Inventory Location ID
                inventory_lot_id: Inventory Lot ID
                parent_id: null
                per_head: false
                type: 50lb Bag Of Feed
                unit: pounds
                updated_at: '2022-03-20 19:15:25'
                weight: 100
      operationId: getByResourceNameByResourceIdFeedingsByFeedingId
      x-operation-id-source: derived
    put:
      tags:
      - Animals & Livestock > Feedings
      summary: Update a Feeding
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                amount: 150
      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
      - name: feeding_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: putByResourceNameByResourceIdFeedingsByFeedingId
      x-operation-id-source: derived
    delete:
      tags:
      - Animals & Livestock > Feedings
      summary: Delete a Feeding
      parameters:
      - 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
      - name: feeding_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteByResourceNameByResourceIdFeedingsByFeedingId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer