> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mielto.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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:**
```bash
GET /connections/integrations/gmail/requirements
GET /connections/integrations/slack/requirements?auth_method_id=oauth2
```

**Response:**
```json
{
    "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
            }
        }
    ]
}
```



## OpenAPI

````yaml api-reference/openapi.json get /api/v1/connections/integrations/{integration_id}/requirements
openapi: 3.1.0
info:
  title: FastAPI app
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/connections/integrations/{integration_id}/requirements:
    get:
      tags:
        - Connections
      summary: Get Integration Requirements
      description: |-
        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:**
        ```bash
        GET /connections/integrations/gmail/requirements
        GET /connections/integrations/slack/requirements?auth_method_id=oauth2
        ```

        **Response:**
        ```json
        {
            "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
                    }
                }
            ]
        }
        ```
      operationId: >-
        get_integration_requirements_api_v1_connections_integrations__integration_id__requirements_get
      parameters:
        - name: integration_id
          in: path
          required: true
          schema:
            type: string
            title: Integration Id
        - name: auth_method_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Specific authentication method ID
            title: Auth Method Id
          description: Specific authentication method ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Connection not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````