Skip to content
ajan.io

Docs menu

On this page

List Integrations

Retrieve private API, MCP, and A2A integrations shared with your API key

Returns private API, MCP, and A2A integrations that are explicitly shared with the API key. Public ajan integrations are not included.

Base URL

https://api.ajan.io/integrations/v1/get

Required Scopes

This endpoint requires one of the following API key scopes:

  • ASSISTANT_API
  • INTEGRATION_API

Example

javascript
const axios = require("axios");

async function listIntegrations() {
  const response = await axios.get(
    "https://api.ajan.io/integrations/v1/get",
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY"
      }
    }
  );

  console.log("Integrations:", response.data.integrations);
}

listIntegrations();

Response Format

Success Response (200 OK)

typescript
{
  integrations: Array<{
    id: string;              // UUID of the integration
    name: string;            // Display name
    description: string;     // Integration description
    iconUrl: string | null;  // Absolute icon URL, or null if none is set
    authType: string;        // Authentication type (e.g., "OAUTH", "API_KEY", "NONE")
    buildByajan: boolean; // Always false. This endpoint does not return public ajan integrations
    integrationType: string; // "API", "MCP", or "A2A"
    serverUrl: string | null; // MCP server URL when integrationType is "MCP", otherwise null
    agentCardUrl: string | null; // A2A agent card URL when integrationType is "A2A", otherwise null
    actions: Array<{
      id: string;            // UUID of the action
      name: string;          // Action display name
      description: string;   // Action description
      kind: string;          // "VIEW", "CHANGE", or "DELETE"
      requiresConfirmation: boolean; // Default confirmation setting on the action
    }>;
  }>;
}

Example Response

json
{
  "integrations": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "name": "My Custom Integration",
      "description": "Internal API connector",
      "iconUrl": null,
      "authType": "API_KEY",
      "buildByajan": false,
      "integrationType": "API",
      "serverUrl": null,
      "agentCardUrl": null,
      "actions": [
        {
          "id": "880e8400-e29b-41d4-a716-446655440001",
          "name": "Get User Data",
          "description": "Retrieves user information",
          "kind": "VIEW",
          "requiresConfirmation": false
        }
      ]
    }
  ]
}

Error Handling

Status CodeDescription
401Invalid or missing API key
429Rate limit exceeded
500Internal server error