Skip to main content
POST
/
passthrough
Passthrough
curl --request POST \
  --url https://api.withterminal.com/tsp/v1/passthrough \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "POST",
  "path": "/reports",
  "headers": {},
  "body": "{\"reportId\":\"1234\"}"
}
'
{
  "method": "POST",
  "path": "/reports",
  "statusCode": 200,
  "headers": {
    "Content-Type": "application/json"
  },
  "response": {
    "reportId": "1234"
  }
}
This endpoint helps ensure that you are never limited by Terminal. You can use passthrough requests to access capabilities that may be limited to a specific TSP or not yet in the normalized model. Our team is here and ready to support custom use cases that may need /passthrough.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Body

application/json
​
method
enum<string>
required

The method for the third-party request, such as GET or POST.

Available options:
GET,
POST,
PUT,
PATCH,
DELETE
Example:

"POST"

​
path
string
required

The path for the third-party request, such as /reports

Example:

"/reports"

​
headers
object

The headers to use for the request (Terminal will handle the connection's authorization headers)

​
body
string

The request body

Example:

"{\"reportId\":\"1234\"}"

Response

OK

​
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:

"/reports"

​
statusCode
integer
required

The resulting status code from the passthrough request.

Example:

200

​
headers
object
required

Any returned headers from the passthrough request.

Example:
{ "Content-Type": "application/json" }
​
response
required

The response body from the passthrough request

Example:
{ "reportId": "1234" }