maintainx-hello-world

name	maintainx-hello-world
description	Create a minimal working MaintainX example - your first work order. Use when starting a new MaintainX integration, testing your setup, or learning basic MaintainX API patterns. Trigger with phrases like "maintainx hello world", "maintainx example", "maintainx quick start", "create first work order", "simple maintainx code".
allowed-tools	Read, Write, Edit, Bash(curl:*), Bash(node:*), Bash(npx:*)
version	1.11.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","maintainx","api","testing"]
compatibility	Designed for Claude Code, also compatible with Codex and OpenClaw

MaintainX Hello World

Overview

Create your first work order using the MaintainX REST API -- the core building block of CMMS operations.

Prerequisites

• Completed maintainx-install-auth setup
• Valid MAINTAINX_API_KEY environment variable
• Node.js 18+ or curl

Instructions

Step 1: Create a Work Order (curl)

curl -X POST https://api.getmaintainx.com/v1/workorders \
  -H "Authorization: Bearer $MAINTAINX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Hello World - Test Work Order",
    "description": "First API-created work order. Safe to delete.",
    "priority": "LOW",
    "status": "OPEN"
  }' | jq .

Expected response:

{
  "id": 12345,
  "title": "Hello World - Test Work Order",
  "status": "OPEN",
  "priority": "LOW",
  "createdAt": "2026-03-19T12:00:00Z"
}

Step 2: Create a Work Order (TypeScript)

// hello-maintainx.ts
import { MaintainXClient } from './maintainx/client';

async function helloMaintainX() {
  const client = new MaintainXClient();

  
   { : workOrder } =  client.({
    : ,
    : ,
    : ,
  });
  .(, workOrder.);

  
   { : fetched } =  client.(workOrder.);
  .(, fetched.);
  .(, fetched.);

  
   { : list } =  client.({
    : ,
    : ,
  });
  .();
}

();