| name | maintainx-install-auth |
| 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.11.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","maintainx","api","authentication"] |
| compatibility | Designed for Claude Code, also compatible with Codex and OpenClaw |
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
- Log into MaintainX at https://app.getmaintainx.com
- Navigate to Settings > Integrations
- Click New Key > Generate Key
- Copy and securely store your API key (shown only once)
Step 2: Configure Environment Variables
export MAINTAINX_API_KEY="your-api-key-here"
echo 'MAINTAINX_API_KEY=your-api-key' >> .env
export MAINTAINX_ORG_ID="your-organization-id"
Step 3: Create API Client Wrapper
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..;
(!key) {
();
}
. = axios.({
: .,
: {
: ,
: ,
...(orgId && { : orgId }),
},
});
....(
response,
.
);
}
() {
(error.) {
{ status, data } = error.;
.(, data);
}
error;
}
() {
..(, { params });
}
() {
..();
}
() {
..(, data);
}
() {
..(, { params });
}
() {
..(, { params });
}
() {
..(, { params });
}
}
{
?: ;
?: ;
?: | | | ;
}
{
: ;
?: ;
?: | | | ;
?: [];
?: ;
?: ;
?: ;
}
{
?: ;
?: ;
?: ;
}
{
?: ;
?: ;
}
{
?: ;
?: ;
}