Get Integration Requirements

Get required fields and validation rules for an integration.

This endpoint returns the fields required to create a connection for a specific integration, including field types, validation rules, and authentication method information.

Use this endpoint to:

• Understand what credentials are needed before creating a connection
• Build dynamic forms for connection creation
• Display helpful information to users about authentication requirements

Example:

GET /connections/integrations/gmail/requirements
GET /connections/integrations/slack/requirements?auth_method_id=oauth2

Response:

{
    "integration_id": "gmail",
    "auth_method": {
        "id": "oauth2",
        "name": "OAuth 2.0",
        "type": "oauth2",
        "description": "Secure authentication with Google account"
    },
    "required_fields": [
        {
            "key": "access_token",
            "label": "Access Token",
            "type": "password",
            "required": true,
            "secure": true,
            "validation": {
                "minLength": 20
            }
        }
    ]
}