REST APITools

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.

Authentication

x-api-keystring
API key authentication

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
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)

bodyany or nullOptional

The request body (for POST, PUT, and PATCH requests)

binary_bodyobjectOptional

Binary body to send. For binary upload via URL: use {url: “https://…”, contentType?: ”…”}. For binary upload via base64: use {base64: ”…”, contentType?: ”…”}.

parameterslist of objectsOptional
Additional HTTP headers or query parameters to include in the request
custom_connection_dataobjectOptionalDeprecated

Response

Successfully executed proxy request and received response
statusdouble
The HTTP status code returned from the proxied API
dataany or null
The response data returned from the proxied API
binary_dataobject or null
Binary body response data. Present when the response is a binary file.
headersmap from strings to strings or null
The HTTP headers returned from the proxied API

Errors