Get Integration

Retrieve details of a specific integration

Using our API via a dedicated deployment? Just replace api.odeus.ai with your deployment's base URL: <deployment-url>/api/public

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

Required Scopes

This endpoint requires the INTEGRATION_API scope.

Path Parameters

Parameter	Type	Required	Description
integrationId	string	Yes	UUID of the integration

Example

const axios = require("axios");

async function getIntegration(integrationId) {
  const response = await axios.get(
    `https://api.odeus.ai/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)

{
  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;
      order: number;
    }>;
    triggers: Array<{
      id: string;
      name: string;
      slug: string;
      description: string;
    }>;
  };
}

Error Handling

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

Odeus intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.