Skip to content
ajan.io

Docs menu

On this page

Get Integration

Retrieve details of a specific integration

Retrieves detailed information about a specific integration, including its actions and configuration.

Base URL

https://api.ajan.io/integrations/v1/{integrationId}

Required Scopes

This endpoint requires the INTEGRATION_API scope.

Parameters

ParameterTypeRequiredDescription
integrationIdstringYesUUID of the integration

Example

javascript
const axios = require("axios");

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

  console.log("Integration:", response.data.integration);
}

getIntegration("550e8400-e29b-41d4-a716-446655440000");

Response Format

Success Response (200 OK)

typescript
{
  integration: {
    id: string;
    name: string;
    description: string;
    authType: string;
    authTestCode: string | null;
    authFields: Array<object>;
    oauthClient: object | null;
    actions: Array<{
      id: string;
      name: string;
      slug: string;
      description: string;
      code: string | null;
      order: number;
      requiresConfirmation: boolean;
      inputFields: Array<{
        slug: string;
        label: string;
        type: string;
        description: string;
        placeholder: string | null;
        required: boolean;
        order: number;
        options: Array<{label: string, value: string}> | null;
        allowMultiSelect: boolean | null;
        contextActionId: string | null;
      }>;
    }>;
    triggers: Array<{
      id: string;
      name: string;
      slug: string;
      description: string;
    }>;
  };
}

Error Handling

Status CodeDescription
400Invalid integration ID format
401Invalid or missing API key
403No access to this integration
404Integration not found
429Rate limit exceeded