Partner Portal Docs Marketplace Sign In

API Docs

Getting started

Endpoints

Versioned, REST‑style endpoints. All responses are JSON.

MethodEndpointDescription
GET/v1/appsList apps
GET/v1/apps/{id}Fetch app by ID
POST/v1/appsCreate an app
DELETE/v1/apps/{id}Delete an app

Auth

Authenticate using API keys or OAuth2 client credentials.

# API key header
curl -H "Authorization: Bearer <API_KEY>" \
     https://api.insightsready.com/v1/apps

Webhooks

Register endpoints to receive event notifications from the marketplace.

{
  "event": "app.installed",
  "workspace_id": "ws_123",
  "app_id": "app_456",
  "timestamp": "2025-01-01T12:00:00Z"
}

Examples

Minimal example using fetch:

async function listApps(){
  const res = await fetch("https://api.insightsready.com/v1/apps",{
    headers:{ Authorization: `Bearer ${YOUR_API_KEY}` }
  });
  const data = await res.json();
  console.log(data);
}