Skip to main content
GET
/
{env_id}
/
{flow_id}
/
{tenant}
/
connectors
/
{connector_id}
/
availableFilters
curl --request GET \
  --url https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/availableFilters \
  --header 'x-api-key: <api-key>'
{
  "filters_version": "1.0.0",
  "reference_data": {
    "vendors": [
      { "vendor_id": "27", "vendor_name": "Acme Corp" },
      { "vendor_id": "62", "vendor_name": "Globex LLC" }
    ]
  },
  "streams": {
    "bills": {
      "supported_operators": ["AND", "OR"],
      "supports_nesting_clauses": true,
      "filters": {
        "vendor_id": {
          "label": "Bill Vendor ID",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN", "LIKE"],
          "target_field": "vendor_id",
          "options": "reference_data.vendors"
        },
        "vendor_name": {
          "label": "Bill Vendor Name",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN", "LIKE"],
          "target_field": "vendor_name",
          "options": "reference_data.vendors"
        },
        "status": {
          "label": "Bill Status",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN"],
          "target_field": "status",
          "options": [
            { "status": "Pending Approval" },
            { "status": "Approved" },
            { "status": "Paid" }
          ]
        }
      }
    }
  }
}

Authentication

x-api-key
string
required
API key for authentication. Include this in the request header.

Path Parameters

env_id
string
required
ID of environment
flow_id
string
required
ID of flow
tenant
string
required
ID of tenant
connector_id
string
required
ID of connectorExample: "netsuite-rest"

Response

filters_version
string
Version of the filters schema format.Example: "1.0.0"
reference_data
object
Top-level lookup tables used as option sources for filterable fields. Keys are referenced via dot notation in stream filter definitions (e.g., "reference_data.vendors").
streams
object
Map of stream names to their filter definitions.
curl --request GET \
  --url https://api.hotglue.com/{env_id}/{flow_id}/{tenant}/connectors/{connector_id}/availableFilters \
  --header 'x-api-key: <api-key>'
{
  "filters_version": "1.0.0",
  "reference_data": {
    "vendors": [
      { "vendor_id": "27", "vendor_name": "Acme Corp" },
      { "vendor_id": "62", "vendor_name": "Globex LLC" }
    ]
  },
  "streams": {
    "bills": {
      "supported_operators": ["AND", "OR"],
      "supports_nesting_clauses": true,
      "filters": {
        "vendor_id": {
          "label": "Bill Vendor ID",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN", "LIKE"],
          "target_field": "vendor_id",
          "options": "reference_data.vendors"
        },
        "vendor_name": {
          "label": "Bill Vendor Name",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN", "LIKE"],
          "target_field": "vendor_name",
          "options": "reference_data.vendors"
        },
        "status": {
          "label": "Bill Status",
          "supported_operators": ["EQ", "NEQ", "IN", "NOT IN"],
          "target_field": "status",
          "options": [
            { "status": "Pending Approval" },
            { "status": "Approved" },
            { "status": "Paid" }
          ]
        }
      }
    }
  }
}