Admin API

Administrative API for platform management, user administration, and system configuration.

Overview

The Admin API provides administrative functionality for:

• User Management - Create, update, and manage user accounts
• Organization Management - Manage organizations and memberships
• API Key Management - Create and revoke API keys
• System Configuration - Configure platform settings
• Analytics & Monitoring - Access usage metrics and logs

Security

⚠️ Important: Admin API keys have elevated privileges. Protect them carefully:

• Never expose admin keys in client-side code
• Rotate keys regularly
• Use environment variables for key storage
• Implement IP whitelisting when possible

Common Operations

Create Organization

const response = await fetch('https://api.integra.dev/admin/v1/organizations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ADMIN_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Acme Corporation',
    email: 'admin@acme.com',
    plan: 'enterprise'
  })
});

Create API Key

const response = await fetch('https://api.integra.dev/admin/v1/api-keys', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ADMIN_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    organization_id: 'org_123',
    name: 'Production API Key',
    scopes: ['workflows:read', 'transactions:write']
  })
});

Get Usage Metrics

const response = await fetch('https://api.integra.dev/admin/v1/analytics/usage?org_id=org_123&period=30d', {
  headers: {
    'Authorization': 'Bearer YOUR_ADMIN_API_KEY'
  }
});

Available Scopes

API keys can be scoped to specific permissions:

• workflows:read - Read workflow data
• workflows:write - Create and modify workflows
• transactions:read - Read transaction data
• transactions:write - Submit transactions
• admin:users - Manage users
• admin:orgs - Manage organizations
• admin:keys - Manage API keys

Audit Logging

All admin API calls are automatically logged for compliance:

// Get audit logs for an organization
const response = await fetch('https://api.integra.dev/admin/v1/audit-logs?org_id=org_123', {
  headers: {
    'Authorization': 'Bearer YOUR_ADMIN_API_KEY'
  }
});

Rate Limits

• Admin API: 500 requests/minute per API key
• Batch operations: 100 requests/minute

Need Help?

Use the “Try It” feature above to test admin endpoints. Make sure you have proper admin credentials!