Forma Transmittals API Field Guide

This page is for version v1. For other versions, use one of these documentation indexes: - v2 (default): https://autodesk-poc.ferndocs.com/v2/llms.txt - v1: https://autodesk-poc.ferndocs.com/v1/llms.txt

This guide introduces the Forma Transmittals API, which provides access to transmittal data within Forma projects.

For more information about how Transmittals work in Forma, see the Transmittals Help.

The Transmittals API includes the following features:

• Retrieve a list of transmittals in a project.
• Get a specific transmittal by its ID.
• Retrieve the folders included in a transmittal.
• Retrieve the documents included in a transmittal.
• Retrieve the recipients of a transmittal.

Limitations

The Transmittals API does not support:

• Creating new transmittals.
• Updating transmittal settings.
• Adding recipients to a transmittal.
• Exporting transmittal folders or document packages.

---

Imported from the Autodesk Platform Services documentation: https://aps.autodesk.com/en/docs/acc/v1/overview/field-guide/transmittals.