Skip to main content
Passthrough enables you to make authenticated HTTP requests directly to an integration’s API. Terminal simplifies API requests to any of the integrations supported by Terminal using the connection tokens you’ve stored on behalf of your users. The requests are transmitted directly to the API of the integration and adhere to the specific API formats of each integration, not Terminal’s standardized format. This approach is useful if you want to retrieve data that Terminal may not make requests for.
Learn more by reviewing the documentation for /passthrough
If the provider endpoint returns a file or another non-JSON payload, use /passthrough/raw instead. Raw Passthrough forwards a successful provider response body directly (with the provider’s Content-Type) instead of returning the PassthroughOutput JSON envelope. When the provider itself responds with an error status, Raw Passthrough returns HTTP 200 with the PassthroughOutput envelope (just like /passthrough), so provider failures are not surfaced as Terminal API errors.

​
Request

Passthrough Input


​
string
required
The method for the third-party request, such as GET or POST.Allowed values: GET POST PUT PATCH DELETE
​
string
required
The path for the third-party request, such as /reportsExample: /reports
​
object
The headers to use for the request (Terminal will handle the connection’s authorization headers)
​
string
The request bodyExample: {"reportId":"1234"}

​
Response

Passthrough Output


​
string
required
The HTTP method that was used when making the request.Example: POST
​
string
default:"/reports"
required
The path that was called with the passthrough request.Example: GET
​
integer
required
The resulting status code from the passthrough request.Example: 200
​
object
required
Any returned headers from the passthrough request.
​
object
required
The response body from the passthrough request