Autodesk Construction Cloud Templates API

Retrieve form templates and their layouts and sections.

GitHub OpenAPI

Operations 3

GET /construction/forms/v1/projects/{projectId}/form-templates Get Form Templates #
GET /construction/forms/v1/projects/{projectId}/layouts/{layoutId} Get Layout #
GET /construction/forms/v2/projects/{projectId}/layouts/{layoutId}/sections/{sectionId} Get Layout Section #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autodesk-construction-cloud:autodesk-construction-cloud-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autodesk-construction-cloud-templates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Construction.Forms Templates API
  version: '1.0'
  contact:
    name: Autodesk Plaform Services
    url: https://aps.autodesk.com/
    email: aps.help@autodesk.com
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service
  x-support: https://stackoverflow.com/questions/tagged/autodesk-platform-services
  description: 'The Autodesk Construction Cloud (ACC) Forms API (Forma) lets you retrieve form

    templates and layouts, create and update forms, read and batch-update form field

    values (including tabular values), and retrieve weather data captured on forms

    for a project.'
servers:
- url: https://developer.api.autodesk.com
security:
- 3-legged: []
tags:
- name: Templates
  description: Retrieve form templates and their layouts and sections.
paths:
  /construction/forms/v1/projects/{projectId}/form-templates:
    parameters:
    - $ref: '#/components/parameters/ProjectId'
    get:
      tags:
      - Templates
      summary: Get Form Templates
      operationId: getFormTemplates
      description: Returns all project's form templates the user has access to.
      parameters:
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/LimitMax50'
      - name: updatedAfter
        in: query
        required: false
        description: Return Templates updated after specified time.
        schema:
          type: string
          format: date-time
      - name: updatedBefore
        in: query
        required: false
        description: Return Templates updated before specified time.
        schema:
          type: string
          format: date-time
      - name: sortOrder
        in: query
        required: false
        description: 'Return Templates in specified sorted order. Possible values: desc, asc'
        schema:
          type: string
          enum:
          - desc
          - asc
      responses:
        '200':
          description: Form Templates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormTemplatesPage'
              examples:
                example-1:
                  value:
                    data:
                    - projectId: 9ba6681e-1952-4d54-aac4-9de6d9858dd4
                      id: 2f634a22-779d-4930-9f08-8391a41fea05
                      name: Daily Report
                      status: active
                      templateType: pg.template_type.daily_report
                      userPermissions:
                      - permissions:
                        - submit
                        userId: USER123A
                      groupPermissions:
                      - permissions:
                        - manage
                        roleKey: hq_access_level:admin
                        roleName: Admin
                      createdBy: USER123A
                      updatedAt: '2020-11-20T16:13:33.615127+00:00'
                      isPdf: true
                      pdfUrl: https://link.to/form.pdf
                      forms:
                        url: https://developer.api.autodesk.com/construction/forms/v1/projects/9ba6681e-1952-4d54-aac4-9de6d9858dd4/forms?templateId=2f634a22-779d-4930-9f08-8391a41fea05
                      currentLayoutId: 123e4567-e89b-12d3-a456-426614174000
                    pagination:
                      offset: 0
                      limit: 50
                      totalResults: 1
                      nextUrl: null
        '400':
          description: The request is invalid due to malformed syntax or a missing request header.
        '401':
          description: The request lacks valid authentication credentials.
        '403':
          description: The client is authenticated but does not have permission to access the resource.
        '404':
          description: The resource cannot be found.
        '429':
          description: The request exceeds the rate limit for this resource.
        '500':
          description: The request failed due to an internal server error.
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/construction/forms/v1/projects/{projectId}/form-templates" -H "Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a"'
  /construction/forms/v1/projects/{projectId}/layouts/{layoutId}:
    parameters:
    - $ref: '#/components/parameters/ProjectId'
    - name: layoutId
      in: path
      required: true
      description: The unique identifier of the layout.
      schema:
        type: string
    get:
      tags:
      - Templates
      summary: Get Layout
      operationId: getLayout
      description: 'Returns layout information for a form template.


        Layouts define the structure and configuration of form templates, including sections, fields, and their properties.'
      responses:
        '200':
          description: Layout information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LayoutDetail'
              examples:
                example-1:
                  value:
                    layout:
                      uid: 123e4567-e89b-12d3-a456-426614174000
                      type: form
                      description: Standard form layout for field reports
                      hasSectionAssignees: false
                    sections:
                    - uid: 123e4567-e89b-12d3-a456-426614174001
                      layoutUid: 123e4567-e89b-12d3-a456-426614174000
                      sortIndex: 0
                      displayIndex: 0
                      type: section
                      assigneeType: user
                      assigneeId: ''
                      label: General Information
                      description: ''
        '400':
          description: The request is invalid due to malformed syntax or a missing request header.
        '401':
          description: The request lacks valid authentication credentials.
        '403':
          description: The client is authenticated but does not have permission to access the resource.
        '404':
          description: The resource cannot be found.
        '429':
          description: The request exceeds the rate limit for this resource.
        '500':
          description: The request failed due to an internal server error.
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/construction/forms/v1/projects/{projectId}/layouts/{layoutId}" -H "Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a"'
  /construction/forms/v2/projects/{projectId}/layouts/{layoutId}/sections/{sectionId}:
    parameters:
    - $ref: '#/components/parameters/ProjectId'
    - name: layoutId
      in: path
      required: true
      description: The unique identifier of the layout.
      schema:
        type: string
    - name: sectionId
      in: path
      required: true
      description: The unique identifier of the section.
      schema:
        type: string
    get:
      tags:
      - Templates
      summary: Get Layout Section
      operationId: getLayoutSection
      description: 'Returns detailed information about a specific section within a form layout.


        Sections contain form fields, tables, and other UI elements that make up the structure of a form.'
      responses:
        '200':
          description: Layout section information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectionDetail'
              examples:
                example-1:
                  value:
                    section:
                      uid: 123e4567-e89b-12d3-a456-426614174001
                      layoutUid: 123e4567-e89b-12d3-a456-426614174000
                      sortIndex: 0
                      displayIndex: 0
                      type: section
                      assigneeType: user
                      assigneeId: ''
                      label: General Information
                      description: ''
                    sectionItems:
                    - uid: 223e4567-e89b-12d3-a456-426614174002
                      layoutUid: 123e4567-e89b-12d3-a456-426614174000
                      sectionUid: 123e4567-e89b-12d3-a456-426614174001
                      sortIndex: 0
                      displayIndex: 0
                      type: field
                      size: normal
                      label: ''
                      schema: ''
                      valueName: arrayVal
                      description: ''
                      isRequired: false
                      modifier: ''
                      presets:
                      - value: ''
                    tableColumns: {}
                    actions:
                    - uid: 323e4567-e89b-12d3-a456-426614174003
                      layoutUid: 123e4567-e89b-12d3-a456-426614174000
                      condition:
                        type: and
                        operator: eq
                        left: {}
                        right: {}
                        conditions:
                        - {}
                      effect:
                        type: hide
                        target: ''
                        value: ''
        '400':
          description: The request is invalid due to malformed syntax or a missing request header.
        '401':
          description: The request lacks valid authentication credentials.
        '403':
          description: The client is authenticated but does not have permission to access the resource.
        '404':
          description: The resource cannot be found.
        '429':
          description: The request exceeds the rate limit for this resource.
        '500':
          description: The request failed due to an internal server error.
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/construction/forms/v2/projects/{projectId}/layouts/{layoutId}/sections/{sectionId}" -H "Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a"'
components:
  schemas:
    Pagination:
      type: object
      description: Request pagination information.
      properties:
        offset:
          type: integer
          description: The number of results skipped.
        limit:
          type: integer
          description: The maximum number of results per page.
        totalResults:
          type: integer
          description: The total number of results.
        nextUrl:
          type:
          - string
          - 'null'
          description: The URL for the next page of results. The value can be null if it is the last page.
    SectionDetail:
      type: object
      description: Detailed layout section information.
      properties:
        section:
          $ref: '#/components/schemas/LayoutSection'
        sectionItems:
          type: array
          description: The fields and tables within the section.
          items:
            $ref: '#/components/schemas/SectionItem'
        tableColumns:
          type: object
          description: Map of table UIDs to their column definitions. Only present for sections containing tables.
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/TableColumn'
        actions:
          type: array
          description: Conditional logic rules that apply to this section.
          items:
            $ref: '#/components/schemas/SectionAction'
    LayoutSection:
      type: object
      description: Metadata about a layout section.
      properties:
        uid:
          type: string
          format: uuid
          description: The unique identifier of the section.
        layoutUid:
          type: string
          format: uuid
          description: The unique identifier of the parent layout.
        sortIndex:
          type: integer
          description: The sort order index of the section.
        displayIndex:
          type: integer
          description: The display order index of the section.
        type:
          type: string
          description: 'The type of the section. Will always be: section.'
          enum:
          - section
        assigneeType:
          type: string
          description: 'The type of assignee for the section. Possible values: user, company, role'
          enum:
          - user
          - company
          - role
        assigneeId:
          type: string
          description: The ID of the assignee for the section.
        label:
          type: string
          description: The label of the section.
        description:
          type: string
          description: The description of the section.
    FormTemplate:
      type: object
      description: A form template.
      properties:
        projectId:
          type: string
          description: Unique indentifier of the project the template belongs to.
        id:
          type: string
          description: The unique identifier of the template.
        name:
          type: string
          description: Display name of template.
        status:
          type: string
          description: 'Status of template: "active", "inactive" (archived), or "deleted" Possible values: active, inactive, deleted'
          enum:
          - active
          - inactive
          - deleted
        templateType:
          type: string
          description: 'User supplied type of template. Can be a custom string or one of the standard template types: pg.template_type.daily_report, pg.template_type.quality, pg.template_type.safety, pg.template_type.punchlist, pg.template_type.commissioning, pg.template_type.time_sheet, pg.template_type.other.'
        userPermissions:
          type: array
          description: Permissions on this template assigned to individual users.
          items:
            $ref: '#/components/schemas/TemplateUserPermission'
        groupPermissions:
          type: array
          description: Permissions on this template assigned to companies and roles.
          items:
            $ref: '#/components/schemas/TemplateGroupPermission'
        createdBy:
          type: string
          description: The unique identifier of the user who created the template.
        updatedAt:
          type: string
          format: date-time
          description: The date when the template was last updated, UTC date and time in ISO-8601 format.
        isPdf:
          type: boolean
          description: A flag that indicates whether the template has a PDF or not.
        pdfUrl:
          type: string
          description: For PDF forms, the URL to download the form's PDF.
        forms:
          type: object
          description: Reference to fetch forms created from this template.
          properties:
            url:
              type: string
              description: URL to retrieve resources.
        currentLayoutId:
          type: string
          format: uuid
          description: The unique identifier of the form template's current layout, if it is not a PDF template. This can be used to retrieve detailed layout information via the GET layouts endpoint.
    Layout:
      type: object
      properties:
        uid:
          type: string
          format: uuid
          description: The unique identifier of the layout.
        type:
          type: string
          description: 'The type of the layout. Will always be: form.'
          enum:
          - form
        description:
          type: string
          description: The description of the layout.
        hasSectionAssignees:
          type: boolean
          description: Determines if section assignment is enabled.
    SectionAction:
      type: object
      properties:
        uid:
          type: string
          format: uuid
          description: The unique identifier of the action.
        layoutUid:
          type: string
          format: uuid
          description: The unique identifier of the parent layout.
        condition:
          $ref: '#/components/schemas/ActionCondition'
        effect:
          $ref: '#/components/schemas/ActionEffect'
    ActionCondition:
      type: object
      description: The condition which if met will cause the effect (the 'if').
      properties:
        type:
          type: string
          description: 'Possible values: and, or, comparison'
          enum:
          - and
          - or
          - comparison
        operator:
          type: string
          description: 'Possible values: eq, ne, gt, gte, lt, lte, in, not_in, contains, not_contains'
          enum:
          - eq
          - ne
          - gt
          - gte
          - lt
          - lte
          - in
          - not_in
          - contains
          - not_contains
        left:
          type: object
        right:
          type: object
        conditions:
          type: array
          items:
            type: object
    TemplateUserPermission:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
        userId:
          type: string
    ActionEffect:
      type: object
      description: The effect which applies if the condition is met (the 'then').
      properties:
        type:
          type: string
          description: 'Possible values: hide, show, require, not_require, set_value'
          enum:
          - hide
          - show
          - require
          - not_require
          - set_value
        target:
          type: string
        value:
          type: string
    TableColumn:
      type: object
      properties:
        uid:
          type: string
          format: uuid
          description: The unique identifier of the table column.
        layoutUid:
          type: string
          format: uuid
          description: The unique identifier of the parent layout.
        layoutSectionItemUid:
          type: string
          format: uuid
          description: The unique identifier of the parent layout section item.
        sortIndex:
          type: integer
          description: The sort order index of the column.
        type:
          type: string
          description: 'The type of the column. Will always be: column.'
          enum:
          - column
        presets:
          type: array
          description: Autocomplete or drop-down options.
          items:
            $ref: '#/components/schemas/Preset'
        valuesProvider:
          type: string
          description: Provider for dropdown values.
        calc:
          type: string
          description: Calculation configuration for the column.
        columnKey:
          type: string
          description: Unique key identifier for the column. This is used in expressions.
        columnType:
          type: string
          description: 'The data type of the column. Custom tables support multiple column types: text_val (Text input), number_val (Decimal numbers), integer_val (Whole numbers), array_val (Dropdown/multi-select - use with presets or valuesProvider), uid_val (Reference fields such as companies, roles - use with valuesProvider), svg_val (Signatures - coming soon for custom tables), date_val (Date picker), time_val (Time picker), timespan_val (Duration/time span).

            '
          enum:
          - text_val
          - number_val
          - integer_val
          - array_val
          - uid_val
          - svg_val
          - date_val
          - time_val
          - timespan_val
        expression:
          type: string
          description: The expression for the column.
        label:
          type: string
          description: The label for the column.
    LayoutDetail:
      type: object
      description: Detailed layout information.
      properties:
        layout:
          $ref: '#/components/schemas/Layout'
        sections:
          type: array
          description: The list of sections within the layout.
          items:
            $ref: '#/components/schemas/LayoutSection'
    FormTemplatesPage:
      type: object
      description: A page of form templates.
      properties:
        data:
          type: array
          description: List of form templates in the project.
          items:
            $ref: '#/components/schemas/FormTemplate'
        pagination:
          $ref: '#/components/schemas/Pagination'
    SectionItem:
      type: object
      properties:
        uid:
          type: string
          format: uuid
          description: The unique identifier of the section item.
        layoutUid:
          type: string
          format: uuid
          description: The unique identifier of the parent layout.
        sectionUid:
          type: string
          format: uuid
          description: The unique identifier of the parent section.
        sortIndex:
          type: integer
          description: The sort order index of the item within the section.
        displayIndex:
          type: integer
          description: The display order index of the item.
        type:
          type: string
          description: 'What type of UI component should be generated for this element. Possible values: field, table'
          enum:
          - field
          - table
        size:
          type: string
          description: 'On a table column/Free Text field, size:large indicates multi-line text. Possible values: normal, large'
          enum:
          - normal
          - large
        label:
          type: string
          description: The field label/question text.
        schema:
          type: string
          description: Identifier for the field. For table section items, this is the table schema UUID used as the fieldId path parameter for GET table values.
        valueName:
          type: string
          description: 'Determines the question type and value name for answering. Possible values: arrayVal, choiceVal, dateVal, numberVal, textVal, toggleVal, svgVal'
          enum:
          - arrayVal
          - choiceVal
          - dateVal
          - numberVal
          - textVal
          - toggleVal
          - svgVal
        description:
          type: string
          description: Text displayed with the question for additional context.
        isRequired:
          type: boolean
          description: Determines if the question must be filled before submission.
        modifier:
          type: string
          description: Additional modifier for the field behavior.
        presets:
          type: array
          description: Autocomplete or drop-down options.
          items:
            $ref: '#/components/schemas/Preset'
    Preset:
      type: object
      properties:
        value:
          type: string
    TemplateGroupPermission:
      type: object
      properties:
        permissions:
          type: array
          items:
            type: string
        roleKey:
          type: string
        roleName:
          type: string
  parameters:
    LimitMax50:
      name: limit
      in: query
      required: false
      description: 'The maximum number of results per page. Possible values: 1-50. Default value: 50.'
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 50
    ProjectId:
      name: projectId
      in: path
      required: true
      description: The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the Forma API by removing the "b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.
      schema:
        type: string
    Offset:
      name: offset
      in: query
      required: false
      description: 'The number of records to skip before returning results. Default value: 0. To retrieve subsequent pages, increase the offset by the number of records returned in the previous request.'
      schema:
        type: integer
  securitySchemes:
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: ''
          refreshUrl: ''
          scopes: {}
    3-legged-implicit:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: ''
          refreshUrl: ''
          scopes: {}
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: ''
          tokenUrl: ''
          refreshUrl: ''
          scopes: {}
x-provenance:
  method: harvested
  publisher: Autodesk Construction Cloud
  source: https://raw.githubusercontent.com/autodesk-platform-services/aps-sdk-openapi/main/forma/forms/forms.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)