​
Overview

The Opsmatic API provides programmatic access to your workflow monitoring data, analytics, and platform management features. Build custom integrations, create automated reports, and extend Opsmatic’s functionality to fit your unique needs.

​
Base URL

https://api.opsmatic.com/v1

​
Authentication

All API requests require authentication using an API key: 
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.opsmatic.com/v1/connections

​
Getting Your API Key

1

Access Settings

Go to your Profile Settings in the Opsmatic dashboard
2

Navigate to API

Click on the “API” tab in your settings
3

Generate Key

Click “Generate API Key” and copy the generated key
4

Store Securely

Store your API key securely - it won’t be shown again

​
Core Endpoints

Connections

Manage your n8n and Make.com connections programmatically

Analytics

Access execution logs, performance metrics, and availability data

Organizations

Manage team organizations and member permissions

Workflows

Retrieve workflow information and execution history

​
Rate Limits

  • Free Plan: 100 requests per hour
  • Pro Plan: 1,000 requests per hour
  • Enterprise: Custom limits
Rate limit headers are included in all responses: 
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

​
Response Format

All API responses use JSON format: 
{
  "success": true,
  "data": {
    // Response data
  },
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 100
  }
}

​
Error Handling

Errors return appropriate HTTP status codes with detailed error information: 
{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired",
    "details": {}
  }
}

​
Common Status Codes

Status CodeDescription
200Success
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Internal Server Error

​
Quick Start Example

Get your connections: 
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.opsmatic.com/v1/connections
Response: 
{
  "success": true,
  "data": [
    {
      "id": "conn_123",
      "service_type": "n8n",
      "service_name": "Production n8n",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}