API Referencev3Tools

Execute proxy request

Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details.

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
endpointstringRequired

The API endpoint to call (absolute URL or path relative to base URL of the connected account)

methodenumRequired

The HTTP method to use for the request

Allowed values:
connected_account_idstringOptionalformat: "connectedAccountId"

The ID of the connected account to use for authentication (if not provided, will use the default account for the project)

parameterslist of objectsOptional

Additional HTTP headers or query parameters to include in the request

Response

Successfully executed proxy request and received response

statusinteger

The HTTP status code returned from the proxied API

headersmap from strings to stringsOptional

The HTTP headers returned from the proxied API