Connection Definitions
List Connection Definitions
get/v1/connection-definitions
Request
- Base URL: https://api.withone.ai
- URL: https://api.withone.ai/v1/connection-definitions
- Auth: API key in header X-One-Secret
Query parameters
platformstring nullable
Platform identifier (e.g., "gmail", "shopify", "hubspot").
namestring nullable
status'not_available' | 'beta' | 'alpha' | 'generally_available'
type'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom'
keystring nullable
Connection key for the target platform.
versionstring nullable
activeboolean nullable
inactiveboolean
hasOAuthboolean nullable
showAuthenticationboolean
limitinteger
Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.
pageinteger
Page number for pagination (1-indexed). Defaults to 1.
skipinteger
Number of items to skip before the first returned item. Defaults to 0. Most callers should leave this at 0 and rely on page + limit.
Response
Paginated list of connection definitions
Changes
No recorded changes to this operation across all 1 revision of this API.