Farmbrite Schedule API

openapi: 3.2.0
info:
  title: Farmbrite API Developers Documentation Schedule 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: Schedule
  description: 'Schedule items are calendar events. These could be reminders for future appointments or activities that need to be done. They are similar to tasks, but have slightly different properties and are not usually used to track the completion of activities.


    They can be assigned to different users in your account and can be associated with different resources, specifically:


    - Livestock `/animals`

    - Grow Locations `/plots`

    - Equipment `/tools`


    You can access and create resource specific items under that resource.


    For example`[GET] /animals/:animal_id/activities` will fetch the schedule for this animal.'
paths:
  /activities:
    post:
      tags:
      - Schedule
      summary: Create an Activity
      description: 'Create a new schedule item


        You can create a schedule item at your account level using the `/schedule` path or under a supported resource (livestock, grow locations or equipment by using the path `/:resource_type/:resource_id/activies`. For example`[GET] /animals/:id/activies` will fetch the schedule for this animal.


        ### **Parameters**


        **title** **`REQUIRED`**


        The name of your schedule item.


        ---


        **start_time** **`REQUIRED`**


        Starting DateTime of your event in `''YYYY-MM-DD HH:MM''` format. A value is required if `all_day` is set to `false`.


        ---


        **end_time** **`REQUIRED`**


        Ending DateTime of your event in `''YYYY-MM-DD HH:MM''` format. A value is required if `all_day` is set to `false`.


        ---


        **assigned_to_id** `OPTIONAL`


        The ID or email address of the Farmbrite user to assign the item to.


        ---


        **all_day** `OPTIONAL`


        Boolean value to indicate the event is all day. Defaults to `false`.


        ---


        **description** `OPTIONAL`


        A summary description of the item.


        ---


        **reference_type** `OPTIONAL`


        Used to link the item to another resource. Supported values are:


        > "animal", "equipment", "plant", "location"


        When providing a `reference_type`, you should also provide a `reference_id`. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/activies`.


        ---


        **reference_id** `OPTIONAL`


        A Farmbrite ID for the resource type that this record is associated with. This can also be accomplished by creating the schedule item through its parent resource path. eg; `/animals/:animal_id/activies`.


        ---


        **color** `OPTIONAL`


        A HEX color value to set the item''s color on the calendar or lis view.


        ---


        **latitude** `OPTIONAL`


        A latitude value used, with longitude, to tag a certain location on the map.


        ---


        **longitude** `OPTIONAL`


        A longitude value used if wanting to tag a certain location on the map.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                color: '#bdbdbd'
                title: Title
                description: ''
                reference_id: Related Resource ID
                reference_type: Related Resource Type
                assigned_to_id: Farmbrite User ID or Email
                latitude: null
                longitude: null
                start_time: 2026-01-01 11:00
                end_time: 2026-01-01 11:30
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: postActivities
      x-operation-id-source: derived
    get:
      tags:
      - Schedule
      summary: List Activities
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                data:
                - id: GUID
                  period: Does not repeat
                  color: '#bdbdbd'
                  end_time: '2021-12-26 07:30:00'
                  start_time: '2021-12-26 07:00:00'
                  all_day: true
                  title: Delivery Expected from Cow X
                  send_reminders: false
                  description: Delivery Expected
                  reference_id: 5b6878f638221cadc1000005
                  reference_type: animals
                  created_by: System User
      operationId: getActivities
      x-operation-id-source: derived
  /activities/{activitity_id}:
    get:
      tags:
      - Schedule
      summary: Retrieve an Activity
      parameters:
      - name: activitity_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                id: GUID
                period: Does not repeat
                color: '#bdbdbd'
                checklist: []
                title: Appointment
                start_time: '2022-01-08 00:00:00'
                end_time: '2022-01-08 00:00:00'
                all_day: false
                description: ''
                reference_type: animals
                reference_id: animal id
                todo: false
                priority: null
                created_by: User
                created_by_id: User ID
                complete: false
                updated_at: '2022-01-07 01:54:32'
                created_at: '2022-01-07 01:54:32'
      operationId: getActivitiesByActivitityId
      x-operation-id-source: derived
  /activities/{activity_id}:
    put:
      tags:
      - Schedule
      summary: Update an Activity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                title: Title
                description: Description
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: activity_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: putActivitiesByActivityId
      x-operation-id-source: derived
    delete:
      tags:
      - Schedule
      summary: Delete an Activity
      parameters:
      - name: activity_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
      operationId: deleteActivitiesByActivityId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer