AssetLab Forms API

openapi: 3.2.0
info:
  title: Assetlab Ca Forms API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Forms across 2 of this provider''s published API definitions: assetlab-ca-openapi.yaml, assetlab-ca-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
  description: Production
security:
- BearerAuth: []
tags:
- name: Forms
  description: Form templates, items, and read-only inspection/checklist responses
paths:
  /form-templates:
    get:
      operationId: listFormTemplates
      summary: List form templates
      tags:
      - Forms
      description: Returns a paginated list of form templates. Requires `form_templates:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/search'
      - name: module
        in: query
        required: false
        description: Only records in this workspace. `none` returns shared ones only.
        schema:
          type: string
          enum:
          - facilities
          - infrastructure
          - none
      - name: status
        in: query
        schema:
          type: string
          enum:
          - draft
          - published
          - archived
        description: Filter by status
      - name: work_category_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by work category
      responses:
        '200':
          description: Paginated form template list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormTemplate'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    post:
      operationId: createFormTemplate
      summary: Create form template
      tags:
      - Forms
      description: Requires `form_templates:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormTemplateCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplate'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-templates/{id}:
    get:
      operationId: getFormTemplate
      summary: Get form template by ID
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Form template detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplate'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateFormTemplate
      summary: Update form template
      tags:
      - Forms
      description: Requires `form_templates:write` scope. Immutable fields are silently stripped.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormTemplateUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplate'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteFormTemplate
      summary: Delete form template
      tags:
      - Forms
      description: Requires `form_templates:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-template-items:
    get:
      operationId: listFormTemplateItems
      summary: List form template items
      tags:
      - Forms
      description: Returns a paginated list of form template items, ordered by sort order. Requires `form_template_items:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: template_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by form template ID
      responses:
        '200':
          description: Paginated form template item list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormTemplateItem'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    post:
      operationId: createFormTemplateItem
      summary: Create form template item
      tags:
      - Forms
      description: Requires `form_template_items:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormTemplateItemCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplateItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-template-items/{id}:
    get:
      operationId: getFormTemplateItem
      summary: Get form template item by ID
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Form template item detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplateItem'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateFormTemplateItem
      summary: Update form template item
      tags:
      - Forms
      description: Requires `form_template_items:write` scope. Immutable fields (template_id, item_key) are silently stripped.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormTemplateItemUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormTemplateItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteFormTemplateItem
      summary: Delete form template item
      tags:
      - Forms
      description: Requires `form_template_items:write` scope.
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-responses:
    get:
      operationId: listFormResponses
      summary: List form responses
      tags:
      - Forms
      description: Returns a paginated list of form responses. Requires `form_responses:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: subject_type
        in: query
        schema:
          type: string
        description: Filter by subject type
      - name: subject_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by subject ID
      - name: template_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by form template ID
      - name: status
        in: query
        schema:
          type: string
        description: Filter by status
      responses:
        '200':
          description: Paginated form response list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormResponse'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    post:
      operationId: createFormResponse
      summary: Attach a form to a record
      tags:
      - Forms
      description: 'Attaches a published form to one record so it can be filled in. The template''s questions are

        snapshotted at attach time, so later edits to the template never change a form already in

        progress — which is why `snapshot`, `template_version`, `lineage_id` and `status` cannot be

        supplied by the caller.


        A record holds at most one form; attaching a second returns 409. To put a form on every work

        order a PM schedule generates, set `form_template_id` on the PM schedule instead of calling

        this per work order.


        Answering and completing a form happen in the AssetLab app, not through this API.

        Requires `form_responses:write` scope.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormResponseCreate'
      responses:
        '201':
          description: Attached
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: A form is already attached to this record
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-responses/{id}:
    get:
      operationId: getFormResponse
      summary: Get form response by ID
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Form response detail (includes snapshot)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormResponse'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteFormResponse
      summary: Detach a form from its record
      tags:
      - Forms
      description: 'Removes the form from the record it is attached to, together with any answers already given.

        Requires `form_responses:write` scope.'
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          $ref: '#/components/responses/Deleted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-response-answers:
    get:
      operationId: listFormResponseAnswers
      summary: List form response answers
      tags:
      - Forms
      description: Returns a paginated list of per-question answer values (read-only). Requires `form_response_answers:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - name: response_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by form response ID
      - name: item_key
        in: query
        schema:
          type: string
        description: Filter by item key
      responses:
        '200':
          description: Paginated form response answer list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FormResponseAnswer'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
  /form-response-answers/{id}:
    get:
      operationId: getFormResponseAnswer
      summary: Get form response answer by ID
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Form response answer detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/FormResponseAnswer'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://ksirnjovowpvamgcnapt.supabase.co/functions/v1/api-gateway/v1
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PayloadTooLarge:
      description: Request body exceeds size limit
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Deleted:
      description: Resource deleted
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              message:
                type: string
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request (validation error or malformed input)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Insufficient permissions - missing scope, or a resource the organization's plan does not include
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    FormTemplateItemUpdate:
      type: object
      description: template_id and item_key are immutable and are silently stripped.
      properties:
        sort_order:
          type: integer
          minimum: 0
        item_type:
          type: string
          enum:
          - section
          - checkbox
          - single_select
          - multi_select
          - number
          - text
          - photo
          - team_members
          - signature
        label:
          type: string
          maxLength: 2000
        help_text:
          type: string
          nullable: true
          maxLength: 5000
        required:
          type: boolean
          nullable: true
        options:
          type: array
          nullable: true
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
            required:
            - value
            - label
        config:
          type: object
          nullable: true
        visible_when:
          type: object
          nullable: true
          properties:
            itemKey:
              type: string
            op:
              type: string
            value: {}
          required:
          - itemKey
          - op
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    FormTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
        lineage_id:
          type: string
          format: uuid
          nullable: true
          description: Only in detail response
        version:
          type: integer
          nullable: true
        is_current:
          type: boolean
          nullable: true
        name:
          type: string
        description:
          type: string
          nullable: true
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        module:
          type: string
          nullable: true
          enum:
          - facilities
          - infrastructure
          - null
          description: Workspace it is offered in. Null = shared by both.
        status:
          type: string
          nullable: true
          enum:
          - draft
          - published
          - archived
        created_by:
          type: string
          nullable: true
          description: Only in detail response
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    FormTemplateItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        template_id:
          type: string
          format: uuid
        item_key:
          type: string
        sort_order:
          type: integer
        item_type:
          type: string
          enum:
          - section
          - checkbox
          - single_select
          - multi_select
          - number
          - text
          - photo
          - team_members
          - signature
        label:
          type: string
        help_text:
          type: string
          nullable: true
        required:
          type: boolean
          nullable: true
        options:
          type: array
          nullable: true
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
            required:
            - value
            - label
        config:
          type: object
          nullable: true
          description: Per-type configuration (e.g. min, max, unit, multiline)
        visible_when:
          type: object
          nullable: true
          properties:
            itemKey:
              type: string
            op:
              type: string
            value: {}
          required:
          - itemKey
          - op
          description: Conditional-visibility rule referencing another item
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    FormResponseAnswer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        response_id:
          type: string
          format: uuid
        item_key:
          type: string
        item_type:
          type: string
          nullable: true
        value_text:
          type: string
          nullable: true
        value_number:
          type: number
          nullable: true
        value_boolean:
          type: boolean
          nullable: true
        value_json:
          type: object
          nullable: true
        answered_by:
          type: string
          nullable: true
        answered_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    FormResponseCreate:
      type: object
      required:
      - template_id
      - subject_type
      - subject_id
      properties:
        template_id:
          type: string
          format: uuid
          description: Published form template to attach. A draft or archived template is rejected.
        subject_type:
          type: string
          enum:
          - work_order
          - pm_schedule
          - infrastructure_asset
          - compliance_record
          - site
          description: Kind of record the form is attached to
        subject_id:
          type: string
          format: uuid
          description: ID of the record, which must belong to the API key's tenant
    FormTemplateItemCreate:
      type: object
      required:
      - template_id
      - item_key
      - sort_order
      - item_type
      - label
      properties:
        template_id:
          type: string
          format: uuid
        item_key:
          type: string
          maxLength: 200
        sort_order:
          type: integer
          minimum: 0
        item_type:
          type: string
          enum:
          - section
          - checkbox
          - single_select
          - multi_select
          - number
          - text
          - photo
          - team_members
          - signature
        label:
          type: string
          maxLength: 2000
        help_text:
          type: string
          nullable: true
          maxLength: 5000
        required:
          type: boolean
          nullable: true
        options:
          type: array
          nullable: true
          items:
            type: object
            properties:
              value:
                type: string
              label:
                type: string
            required:
            - value
            - label
        config:
          type: object
          nullable: true
        visible_when:
          type: object
          nullable: true
          properties:
            itemKey:
              type: string
            op:
              type: string
            value: {}
          required:
          - itemKey
          - op
    Pagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        total:
          type: integer
          example: 142
        total_pages:
          type: integer
          example: 6
    FormResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        template_id:
          type: string
          format: uuid
          nullable: true
        template_version:
          type: integer
          nullable: true
        lineage_id:
          type: string
          format: uuid
          nullable: true
        subject_type:
          type: string
          nullable: true
        subject_id:
          type: string
          format: uuid
          nullable: true
        status:
          type: string
          nullable: true
        snapshot:
          type: object
          nullable: true
          description: Frozen copy of the template at fill time. Only in detail response
        completed_by:
          type: string
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    FormTemplateUpdate:
      type: object
      properties:
        name:
          type: string
          maxLength: 500
        description:
          type: string
          nullable: true
          maxLength: 5000
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        module:
          type: string
          nullable: true
          enum:
          - facilities
          - infrastructure
          - null
          description: Moves it between workspaces. Null = shared by both.
        status:
          type: string
          nullable: true
          enum:
          - draft
          - published
          - archived
    FormTemplateCreate:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          maxLength: 500
        description:
          type: string
          nullable: true
          maxLength: 5000
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        module:
          type: string
          nullable: true
          enum:
          - facilities
          - infrastructure
          - null
          description: Workspace it is offered in. Null or omitted = shared by both.
        status:
          type: string
          nullable: true
          enum:
          - draft
          - published
          - archived
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Resource UUID
    page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
        minimum: 1
      description: Page number
    search:
      name: search
      in: query
      schema:
        type: string
        maxLength: 200
      description: Case-insensitive name search
    per_page:
      name: per_page
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 1000
      description: Items per page
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key from AssetLab Settings > API Keys
x-refined-from:
- assetlab-ca-openapi.yaml
- assetlab-ca-openapi.yaml
x-tagGroups:
- name: Core
  tags:
  - Assets
  - Work Orders
  - Work Requests
  - PM Schedules
  - PM Templates
- name: Facilities
  tags:
  - Sites
  - Buildings
  - Locations
- name: Feature Classification
  tags:
  - Systems
  - System Groups
  - System Classes
  - Asset Types
  - Asset Type Groups
  - Manufacturers
- name: Projects
  tags:
  - Projects
  - Project Sites
  - Project Buildings
  - Project Locations
  - Project System Classes
  - Project System Groups
  - Project Systems
  - Project Assets
  - Project Tasks
  - Project Milestones
  - Project Phases
  - Project Budget Items
  - Project Time Entries
  - Project Comments
  - Project Risks
  - Project Document Folder Templates
- name: Financial
  tags:
  - Budgets
  - Invoices
  - Purchase Orders
  - Expenses
  - Change Orders
  - Cost Categories
  - Asset Costs
  - Asset Replacement Plans
- name: Vendors & Contracts
  tags:
  - Vendors
  - Contracts
  - Vendor Site Assignments
  - Contract Sites
- name: Compliance
  tags:
  - Compliance
  - Compliance Records
- name: Parts & Inventory
  tags:
  - Parts
  - Part Categories
- name: Comments & Documents
  tags:
  - Asset Comments
  - Work Order Comments
  - Asset Documents
  - Project Documents
  - Contract Documents
  - Attachments
  - Upload URLs
- name: Level of Service
  tags:
  - Service Areas
  - Service Area System Classes
  - Service Area Sites
  - LoS Measures
  - LoS Measurements
  - LoS Proposed Targets
  - LoS Targets History
  - System LoS Targets
  - Infrastructure LoS Targets
  - Criticality Modifiers
  - LoS Consequences
  - LoS Status Snapshots
- name: Infrastructure
  tags:
  - Infrastructure Feature Classes
  - Infrastructure Networks
  - Infrastructure Assets
  - Infrastructure Asset Inspections
- name: Dashboard & Analytics
  tags:
  - Dashboard
  - Dashboard Snapshots
  - Site FCI History
  - Asset Risk History
  - Asset Condition Assessments
- name: Configuration
  tags:
  - Asset Statuses
  - Work Categories
  - Building Types
  - Location Types
  - Custom Field Definitions
  - Custom Field Values