Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.withterminal.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Request

Passthrough Input


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

​
Response

Passthrough Output


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