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
            }
        }
    ]
}

GET /api/v1/connections/integrations/{integration_id}/requirements

Get Integration Requirements

cURL

curl --request GET \
  --url https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements

import requests

url = "https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/connections/integrations/{integration_id}/requirements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

integration_id · string · required

Query Parameters

auth_method_id · string | null

Specific authentication method ID

Response

200

application/json

Successful Response