--- name: maintainx-install-auth-216d27a8f216 description: | Install and configure MaintainX REST API authentication. Use when setting up a new MaintainX integration, configuring API keys, or initializing MaintainX API access in your project. Trigger with phrases like "install maintainx", "setup maintainx", "maintainx auth", "configure maintainx API key", "maintainx credentials". allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep version: 1.0.0 license: MIT author: Jeremy Longshore --- # MaintainX Install & Auth ## Overview Set up MaintainX REST API authentication and configure your development environment for CMMS integration. ## Prerequisites - Node.js 18+ or Python 3.10+ - MaintainX account with API access (Professional or Enterprise plan) - Admin access to generate API keys ## Instructions ### Step 1: Generate API Key 1. Log into MaintainX at https://app.getmaintainx.com 2. Navigate to **Settings** > **Integrations** 3. Click **New Key** > **Generate Key** 4. Copy and securely store your API key (shown only once) ### Step 2: Configure Environment Variables ```bash # Set environment variable export MAINTAINX_API_KEY="your-api-key-here" # Or create .env file echo 'MAINTAINX_API_KEY=your-api-key' >> .env # For multi-organization tokens, also set: export MAINTAINX_ORG_ID="your-organization-id" ``` ### Step 3: Create API Client Wrapper ```typescript // src/maintainx/client.ts import axios, { AxiosInstance, AxiosError } from 'axios'; export class MaintainXClient { private client: AxiosInstance; private baseUrl = 'https://api.getmaintainx.com/v1'; constructor(apiKey?: string, orgId?: string) { const key = apiKey || process.env.MAINTAINX_API_KEY; if (!key) { throw new Error('MAINTAINX_API_KEY is required'); } this.client = axios.create({ baseURL: this.baseUrl, headers: { 'Authorization': `Bearer ${key}`, 'Content-Type': 'application/json', ...(orgId && { 'X-Organization-Id': orgId }), }, }); this.client.interceptors.response.use( response => response, this.handleError ); } private handleError(error: AxiosError) { if (error.response) { const { status, data } = error.response; console.error(`MaintainX API Error [${status}]:`, data); } throw error; } // Core API methods async getWorkOrders(params?: WorkOrderQueryParams) { return this.client.get('/workorders', { params }); } async getWorkOrder(id: string) { return this.client.get(`/workorders/${id}`); } async createWorkOrder(data: CreateWorkOrderInput) { return this.client.post('/workorders', data); } async getAssets(params?: AssetQueryParams) { return this.client.get('/assets', { params }); } async getLocations(params?: LocationQueryParams) { return this.client.get('/locations', { params }); } async getUsers(params?: UserQueryParams) { return this.client.get('/users', { params }); } } // Type definitions interface WorkOrderQueryParams { cursor?: string; limit?: number; status?: 'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'DONE'; } interface CreateWorkOrderInput { title: string; description?: string; priority?: 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH'; assignees?: string[]; assetId?: string; locationId?: string; dueDate?: string; } interface AssetQueryParams { cursor?: string; limit?: number; locationId?: string; } interface LocationQueryParams { cursor?: string; limit?: number; } interface UserQueryParams { cursor?: string; limit?: number; } ``` ### Step 4: Verify Connection ```typescript // test-connection.ts import { MaintainXClient } from './maintainx/client'; async function testConnection() { const client = new MaintainXClient(); try { const response = await client.getUsers({ limit: 1 }); console.log('Connection successful!'); console.log('Organization has users:', response.data.users.length > 0); return true; } catch (error) { console.error('Connection failed:', error); return false; } } testConnection(); ``` ```bash # Run test npx ts-node test-connection.ts ``` ### Python Alternative ```python # maintainx_client.py import os import requests from typing import Optional, Dict, Any class MaintainXClient: BASE_URL = "https://api.getmaintainx.com/v1" def __init__(self, api_key: Optional[str] = None, org_id: Optional[str] = None): self.api_key = api_key or os.environ.get("MAINTAINX_API_KEY") if not self.api_key: raise ValueError("MAINTAINX_API_KEY is required") self.headers = { "Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json", } if org_id: self.headers["X-Organization-Id"] = org_id def _request(self, method: str, endpoint: str, **kwargs) -> Dict[str, Any]: url = f"{self.BASE_URL}{endpoint}" response = requests.request(method, url, headers=self.headers, **kwargs) response.raise_for_status() return response.json() def get_work_orders(self, **params) -> Dict[str, Any]: return self._request("GET", "/workorders", params=params) def create_work_order(self, data: Dict[str, Any]) -> Dict[str, Any]: return self._request("POST", "/workorders", json=data) def get_assets(self, **params) -> Dict[str, Any]: return self._request("GET", "/assets", params=params) def get_locations(self, **params) -> Dict[str, Any]: return self._request("GET", "/locations", params=params) # Test connection if __name__ == "__main__": client = MaintainXClient() users = client._request("GET", "/users", params={"limit": 1}) print("Connection successful!") print(f"Found {len(users.get('users', []))} users") ``` ## Output - Environment variable or `.env` file with API key configured - MaintainX client wrapper installed and configured - Successful connection verification output ## Error Handling | Error | Cause | Solution | |-------|-------|----------| | 401 Unauthorized | Invalid or expired API key | Generate new key in Settings > Integrations | | 403 Forbidden | Insufficient permissions | Ensure admin role or correct plan tier | | 404 Not Found | Wrong base URL or endpoint | Use `api.getmaintainx.com/v1` | | Network Error | Firewall blocking HTTPS | Allow outbound 443 to getmaintainx.com | ## Security Best Practices 1. **Never commit API keys** to version control 2. Use environment variables or secret managers 3. Rotate keys periodically (every 90 days recommended) 4. Use organization-specific keys for multi-tenant setups 5. Limit key scope to required operations only ## Resources - [MaintainX API Documentation](https://maintainx.dev/) - [MaintainX Help Center](https://help.getmaintainx.com/) - [Generating API Keys](https://intercom.help/maintainx/en/articles/5658848-generating-api-key-to-integrate-with-other-systems) ## Next Steps After successful auth, proceed to `maintainx-hello-world` for your first API call. --- Source attribution: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/maintainx-pack/skills/maintainx-install-auth/SKILL.md License: MIT License information: https://opensource.org/license/mit Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice MIT License (with OpenAI/Anthropic Rider) Copyright (c) 2026 Jeffrey Emanuel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: ADDITIONAL RIDER / RESTRICTION (OpenAI / Anthropic): This rider is part of the "conditions" of this License. In the event of any conflict between this rider and any other portion of this License, this rider controls. "Restricted Parties" means OpenAI, L.L.C.; Anthropic, PBC; any of their respective Affiliates; and any person or entity acting directly or indirectly on behalf of, for the benefit of, or under the direction of any of the foregoing (including any officer, director, employee, contractor, agent, consultant, service provider, or representative). Notwithstanding any other provision of this License, no rights are granted to any Restricted Party. Any purported license, sublicense, assignment, transfer, or other permission to any Restricted Party is null and void absent the express prior written permission of Jeffrey Emanuel. You may not provide, disclose, distribute, sublicense, sell, lease, lend, host, make available, or otherwise permit access to the Software or any derivative work of the Software (as defined in applicable copyright law) (collectively, "Derivative Works") to or for any Restricted Party. For purposes of this rider, "use" includes, without limitation: copying, modifying, merging, publishing, distributing, sublicensing, selling, transferring, making available, hosting, deploying, executing, benchmarking, testing, analyzing, indexing, or incorporating the Software or any Derivative Works into any dataset, training corpus, evaluation harness, or pipeline for machine learning or other automated systems. This rider applies to the Software and all Derivative Works. As a condition of use, you agree that this rider is a precondition to exercising any rights under this License, and you agree that any distribution of the Software or any Derivative Works must include this rider provision unmodified. Any breach of this rider automatically and immediately terminates the permissions granted by this License. Upon termination, you must immediately cease all use and distribution of the Software and any Derivative Works and destroy all copies under your control. You agree that a breach of this rider would cause irreparable harm and that Jeffrey Emanuel may seek injunctive or other equitable relief to enforce this rider, in addition to any other remedies available at law. To the maximum extent permitted by applicable law, the prevailing party in any action to enforce this rider shall be entitled to recover reasonable attorneys' fees and costs. For purposes of this rider, "Affiliate" means any entity that directly or indirectly controls, is controlled by, or is under common control with the specified party. "Control" means ownership of more than 50% of the voting securities or other ownership interest, or the power to direct management or policies by contract or otherwise. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Mega AI Hub resource metadata Creator / publisher: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/maintainx-pack/skills/maintainx-install-auth/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management Roles: Backend Developer, Growth Product Manager, Product Manager Specialties: API, Backend Tools: Maintainx Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 9c601f610dba3b2a2ca7960cc0f9e8a89fbac609dd2d092d0d61471459fc17b1