Request

Response

    Forms Changelog



    Release Date: 2026-10-21

    Version 2.1.0

    Changed

    Forms API v2 Has Moved to General Availability

    The following endpoints have moved from beta to general availability (GA) and are now available for production use:

    The deprecated GET forms v1 and PUT values:batch-update v1 endpoints will be retired on June 30, 2027. The retirement date has been extended from the previously announced December 29, 2026. See the Forms API Migration Guide (2026 April Release) for migration details.


    Release Date: 2026-08-05

    Added

    Changed

    • The maximum and default page size (limit) for GET custom values was increased from 50 to 100, allowing clients to retrieve more values per request.

    Release Date: 2026-03-31

    Version 2.0.0

    Added

    New Version Endpoints

    • GET forms v2 endpoint with enhanced filtering and sorting:

      • Multi-field sort parameter replaces sortBy/sortOrder
      • New search parameter for text search across forms
      • New include parameter for selectively including additional data (sublocations, inactiveFormTemplates, layoutInfo)
      • New includeSubLocations parameter to include forms from sublocations
      • Form status values now align with the UI (inProgress, inReview, closed, discarded, archived)
    • PUT values:batch-update v2 endpoint with custom table support:

      • Use schema field to identify tables (supports both built-in aliases and custom table UUIDs)
      • Use columnId (UUID) to identify columns on custom tables
      • Enhanced schema validation
    • POST values:batch-delete v2 endpoint for deleting table rows from both built-in and custom tables

    These new version endpoints are currently labeled as Public Beta. The previous versions of these endpoints are deprecated and will be removed on December 29, 2026. We recommend migrating to new version endpoints before that date.

    Update: The retirement date has been extended to June 30, 2027. See the 2026-10-21 release notes above.

    New Endpoints

    • GET custom values for retrieving values of non-tabular (custom) form fields
    • GET table values for retrieving values from a table
    • GET layout for retrieving structure and sections of form template
    • GET section for retrieving detailed section information, including custom values fields, table column definitions (columnId, columnKey, columnType)
    • GET weather for retrieving weather data associated with a form

    These new endpoints are currently labeled as Public Beta.

    Custom Table Support

    • Full support for reading and writing custom tables (user-defined tables on form templates) in addition to the three built-in tables (Work Log, Materials, Equipment)
    • Custom table columns support multiple data types: text, number, integer, dropdown, date, time, duration, signature, and reference fields
    • See the Forms API Migration Guide (2026 April Release) for details on working with custom tables

    Changed

    • Form status values updated to align with the UI:

      • draft → inProgress
      • in_review → inReview
      • submitted → closed
    • The updatedAfter/updatedBefore filters now use inclusive comparison (“at or after”/”at or before”) instead of exclusive

    Check Forms API Migration Guide (2026 April Release) for details when you work on migration.


    Release Date: 2024-09-17

    Version 1.2.3

    Added

    Release Date: 2023-03-21

    Version 1.2.2

    Added

    • New endpoint to create Form instances POST forms.
    • New endpoint to update Form instances PATCH forms/:formId.
    • New endpoint to fill Form fields and tables PUT values:batch-update.
    • New fields in GET forms response

      • createdAt indicating when the form was created on the server
      • userCreatedAt indicating when the form was created on the client
      • lastReopenedBy indicating the user that re-opened the Form (if applicable)
      • lastSubmitterSignature indicating the signature of the reviewer who last submitted the Form (if applicable)
      • Weather now includes provider indicating the source of the weather data

    Release Date: 2023-01-12

    Version 1.2.1

    Removed

    • Discarded forms no longer appear in the response to GET forms. It returns forms with draft, submitted, or archived statuses.

    Release Date: 2022-04-28

    Version 1.2.0

    Added

    • The new assignee type attribute (assigneeType) was added, which enables you to determine the subject (user, role, or company) the form is assigned to. See GET forms for more details.

    Release Date: 2021-09-28

    Version 1.1.0

    Added

    • The new location attribute (locationId) was added, which enables you to determine the location associated with a form. See GET forms for more details.
    • The location filter (locationIds) was added, which enables you to filter forms according to the locations. See the Retrieve Forms Associated With Locations tutorial for more details.