Passthrough request
Forwards an arbitrary HTTP request to the upstream platform. The method, URL path, query parameters, and body are all preserved — credentials are resolved from your connection and signed in automatically. Use this when no first-class action exists for what you need to do on the platform.
Request
- Base URL: https://api.withone.ai
- URL: https://api.withone.ai/v1/passthrough/{key}
- Auth: one of:
- API key in header X-One-Secret
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:write)
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:write)
- OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:write)
Path parameters
API path forwarded to the destination platform (e.g. users/me, contacts). Anything after /v1/passthrough/ is preserved verbatim as the upstream path. Generated clients must URL-encode any / within a single segment as %2F (e.g. users%2Fme), since an OpenAPI path parameter cannot contain a raw slash.
Headers
The action's system_id (from /v1/available-actions). Selects which connection-model definition resolves the upstream call. This is what the SDK's triggerAction sets.
The connection to run against. Required whichever credential you present: it selects the connection, it does not authenticate you, and a request without it is refused before the handler runs.
Selects the tenant this request acts in. Omit it to act in your personal scope.
Selects the tenant this request acts in. Omit it to act in your personal scope.
Response
Response proxied back from the destination API
Changes
No recorded changes to this operation across all 1 revision of this API.