AssetLab Work Orders API

openapi: 3.2.0
info:
  title: Assetlab Ca Work Orders API
  version: '1.0'
  contact:
    name: AssetLab Support
    url: https://assetlab.ca
    email: support@assetlab.ca
  license:
    name: Proprietary
  description: 'Operations tagged Work Orders 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: Work Orders
  description: Corrective, preventive, and emergency work orders
paths:
  /work-orders:
    get:
      operationId: listWorkOrders
      summary: List work orders
      tags:
      - Work Orders
      description: Returns a paginated list of work orders. Requires `work_orders:read` scope.
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per_page'
      - $ref: '#/components/parameters/search'
      - name: status
        in: query
        schema:
          type: string
          enum:
          - NEW
          - IN_PROGRESS
          - ON_HOLD
          - REJECTED
          - COMPLETED
          - CANCELLED
        description: Filter by status
      - name: priority
        in: query
        schema:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - URGENT
        description: Filter by priority
      - name: type
        in: query
        schema:
          type: string
          enum:
          - PM
          - REACTIVE
        description: Filter by type
      - name: site_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by site
      - name: infrastructure_asset_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter by infrastructure feature (mutually exclusive target with asset_id)
      responses:
        '200':
          description: Paginated work order list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkOrder'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    post:
      operationId: createWorkOrder
      summary: Create work order
      tags:
      - Work Orders
      description: Requires `work_orders:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkOrderCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkOrder'
        '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
  /work-orders/{id}:
    get:
      operationId: getWorkOrder
      summary: Get work order by ID
      tags:
      - Work Orders
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: Work order detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkOrder'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateWorkOrder
      summary: Update work order
      tags:
      - Work Orders
      description: Requires `work_orders:write` scope. Immutable fields are silently stripped.
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkOrderUpdate'
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WorkOrder'
        '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: deleteWorkOrder
      summary: Delete work order
      tags:
      - Work Orders
      description: Requires `work_orders: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
  /work-orders/bulk:
    post:
      operationId: bulkCreateWorkOrders
      summary: Bulk create work orders (max 100)
      tags:
      - Work Orders
      description: Create up to 100 work orders in a single request. Requires `work_orders:write` scope.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              maxItems: 100
              items:
                $ref: '#/components/schemas/WorkOrderCreate'
      responses:
        '201':
          description: All items created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkResponse'
        '207':
          $ref: '#/components/responses/MultiStatus'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
    patch:
      operationId: bulkUpdateWorkOrders
      summary: Bulk update work orders (max 100)
      tags:
      - Work Orders
      description: 'Update up to 100 work orders in a single request. Each item must include an `id` field.

        Requires `work_orders:write` scope.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              maxItems: 100
              items:
                type: object
                required:
                - id
                properties:
                  id:
                    type: string
                    format: uuid
      responses:
        '200':
          description: All items updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkResponse'
        '207':
          $ref: '#/components/responses/MultiStatus'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
    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'
    MultiStatus:
      description: Partial success — some items succeeded, others failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BulkResponse'
    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'
  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
  schemas:
    BulkItemResult:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based index in the request array
        success:
          type: boolean
        data:
          type: object
          description: Created/updated record (on success)
        error:
          type: string
          description: Error message (on failure)
        details:
          type: array
          description: Validation error details (on failure)
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
    Error:
      type: object
      properties:
        error:
          type: string
          example: Asset not found
    BulkResponse:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/BulkSummary'
        results:
          type: array
          items:
            $ref: '#/components/schemas/BulkItemResult'
    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
    BulkSummary:
      type: object
      properties:
        total:
          type: integer
          description: Total items in request
        succeeded:
          type: integer
          description: Number that succeeded
        failed:
          type: integer
          description: Number that failed
    SiteRef:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    WorkOrder:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        description:
          type: string
          nullable: true
          description: Only in detail response
        priority:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - URGENT
        status:
          type: string
          enum:
          - NEW
          - IN_PROGRESS
          - ON_HOLD
          - REJECTED
          - COMPLETED
          - CANCELLED
        type:
          type: string
          nullable: true
          enum:
          - PM
          - REACTIVE
        work_order_number:
          type: integer
          nullable: true
        site_id:
          type: string
          format: uuid
          nullable: true
        building_id:
          type: string
          format: uuid
          nullable: true
        location_id:
          type: string
          format: uuid
          nullable: true
          description: Only in detail response
        asset_id:
          type: string
          format: uuid
          nullable: true
        infrastructure_asset_id:
          type: string
          format: uuid
          nullable: true
          description: Infrastructure feature target (mutually exclusive with asset_id)
        infrastructure_asset_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Infrastructure features this record covers. The whole selection is one record; infrastructure_asset_id is kept in sync as the first of them.
        asset_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Assets this work order covers. Kept in sync with asset_id, which is the first of them.
        location_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Locations this work order covers. Kept in sync with location_id, which is the first of them.
        system_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Systems this work order covers.
        location_or_asset:
          type: string
          nullable: true
          description: 'Which association the record is filed under: LOCATION, ASSET, SYSTEM, FEATURE or NETWORK. Inferred from whichever association you send when omitted.'
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        purchase_order_id:
          type: string
          format: uuid
          nullable: true
          description: Purchase order (see /purchase-orders) that paid this work order's actual cost. Counts against the order's remaining balance; null clears it. Must belong to your organization.
        image_url:
          type: string
          nullable: true
          description: Image URL for the work order
        sites:
          $ref: '#/components/schemas/SiteRef'
        buildings:
          $ref: '#/components/schemas/BuildingRef'
        start_date:
          type: string
          format: date
          nullable: true
        due_date:
          type: string
          format: date
          nullable: true
        estimated_time:
          type: number
          nullable: true
          description: Estimated hours
        estimated_cost:
          type: number
          nullable: true
          description: Only in detail response. Money in the organization's currency - GET /v1/organization-settings for currency_code
        actual_hours:
          type: number
          nullable: true
          description: Only in detail response
        completed_at:
          type: string
          format: date-time
          nullable: true
          description: Only in detail response
        completed_by:
          type: string
          nullable: true
          description: Clerk user ID. Only in detail response
        completion_notes:
          type: string
          nullable: true
          description: Only in detail response
        assignees:
          type: array
          items:
            type: string
          nullable: true
          description: Array of assigned Clerk user IDs
        meter_reading:
          type: number
          nullable: true
          description: Meter/odometer reading at time of service
        meter_unit:
          type: string
          nullable: true
          description: Meter unit (km, miles, hours, cycles)
        pm_schedule_id:
          type: string
          format: uuid
          nullable: true
        work_request_id:
          type: string
          format: uuid
          nullable: true
          description: Only in detail response
        created_by:
          type: string
          nullable: true
          description: Clerk user ID
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    BuildingRef:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    WorkOrderCreate:
      type: object
      required:
      - title
      properties:
        title:
          type: string
        description:
          type: string
          nullable: true
        priority:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - URGENT
        status:
          type: string
          enum:
          - NEW
          - IN_PROGRESS
          - ON_HOLD
          - REJECTED
          - COMPLETED
          - CANCELLED
        type:
          type: string
          nullable: true
          enum:
          - PM
          - REACTIVE
        site_id:
          type: string
          format: uuid
          nullable: true
        building_id:
          type: string
          format: uuid
          nullable: true
        location_id:
          type: string
          format: uuid
          nullable: true
        asset_id:
          type: string
          format: uuid
          nullable: true
        infrastructure_asset_id:
          type: string
          format: uuid
          nullable: true
          description: Infrastructure feature target (mutually exclusive with asset_id)
        infrastructure_asset_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Infrastructure features this record covers. The whole selection is one record; infrastructure_asset_id is kept in sync as the first of them.
        start_date:
          type: string
          format: date
          nullable: true
        due_date:
          type: string
          format: date
          nullable: true
        estimated_time:
          type: number
          nullable: true
          description: Estimated hours
        estimated_cost:
          type: number
          nullable: true
          description: Money in the organization's currency - GET /v1/organization-settings for currency_code
        assigned_to:
          type: string
          nullable: true
          description: Single user ID — mapped to assignees array
        assignees:
          type: array
          items:
            type: string
          nullable: true
          description: Array of assigned Clerk user IDs (alternative to assigned_to)
        asset_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Assets this work order covers. Kept in sync with asset_id, which is the first of them.
        location_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Locations this work order covers. Kept in sync with location_id, which is the first of them.
        system_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Systems this work order covers.
        location_or_asset:
          type: string
          nullable: true
          description: 'Which association the record is filed under: LOCATION, ASSET, SYSTEM, FEATURE or NETWORK. Inferred from whichever association you send when omitted.'
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        purchase_order_id:
          type: string
          format: uuid
          nullable: true
          description: Purchase order (see /purchase-orders) that paid this work order's actual cost. Counts against the order's remaining balance; null clears it. Must belong to your organization.
        image_url:
          type: string
          nullable: true
          description: Image URL (upload via POST /upload-urls with bucket asset-images)
        meter_reading:
          type: number
          nullable: true
          description: Meter/odometer reading at time of service
        meter_unit:
          type: string
          nullable: true
          description: Meter unit (km, miles, hours, cycles)
    WorkOrderUpdate:
      type: object
      properties:
        title:
          type: string
        description:
          type: string
          nullable: true
        priority:
          type: string
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - URGENT
        status:
          type: string
          enum:
          - NEW
          - IN_PROGRESS
          - ON_HOLD
          - REJECTED
          - COMPLETED
          - CANCELLED
        type:
          type: string
          nullable: true
          enum:
          - PM
          - REACTIVE
        site_id:
          type: string
          format: uuid
          nullable: true
        building_id:
          type: string
          format: uuid
          nullable: true
        location_id:
          type: string
          format: uuid
          nullable: true
        asset_id:
          type: string
          format: uuid
          nullable: true
        infrastructure_asset_id:
          type: string
          format: uuid
          nullable: true
          description: Infrastructure feature target (mutually exclusive with asset_id)
        infrastructure_asset_ids:
          type: array
          items:
            type: string
            format: uuid
          description: Infrastructure features this record covers. The whole selection is one record; infrastructure_asset_id is kept in sync as the first of them.
        start_date:
          type: string
          format: date
          nullable: true
        due_date:
          type: string
          format: date
          nullable: true
        estimated_time:
          type: number
          nullable: true
          description: Estimated hours
        estimated_cost:
          type: number
          nullable: true
          description: Money in the organization's currency - GET /v1/organization-settings for currency_code
        actual_hours:
          type: number
          nullable: true
        completion_notes:
          type: string
          nullable: true
        assigned_to:
          type: string
          nullable: true
          description: Single user ID — mapped to assignees array
        assignees:
          type: array
          items:
            type: string
          nullable: true
          description: Array of assigned Clerk user IDs (alternative to assigned_to)
        asset_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Assets this work order covers. Kept in sync with asset_id, which is the first of them.
        location_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Locations this work order covers. Kept in sync with location_id, which is the first of them.
        system_ids:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
          description: Systems this work order covers.
        location_or_asset:
          type: string
          nullable: true
          description: 'Which association the record is filed under: LOCATION, ASSET, SYSTEM, FEATURE or NETWORK. Inferred from whichever association you send when omitted.'
        work_category_id:
          type: string
          format: uuid
          nullable: true
          description: Work category (see /work-categories)
        purchase_order_id:
          type: string
          format: uuid
          nullable: true
          description: Purchase order (see /purchase-orders) that paid this work order's actual cost. Counts against the order's remaining balance; null clears it. Must belong to your organization.
        image_url:
          type: string
          nullable: true
          description: Image URL
        meter_reading:
          type: number
          nullable: true
          description: Meter/odometer reading at time of service
        meter_unit:
          type: string
          nullable: true
          description: Meter unit (km, miles, hours, cycles)
  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