Skip to main content
GET
/
{env_id}
/
{flow_id}
/
{tenant}
/
connectors
/
{connector_id}
/
availableFilters
Retrieve Connector Available Filters
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"
            }
          ]
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

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 connector

Example:

"netsuite-rest"

Response

200

filters_version
string

Version of the filters schema format.

reference_data
object

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.