POST
/
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 an ready to support custom use cases that may need /passthrough

Authorizations

Authorization
string
headerrequired

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.

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
path
string
required

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

headers
object

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

body
string

The request body

Response

200 - application/json
method
string
required

The HTTP method that was used when making the request.

path
string
default: /reportsrequired

The path that was called with the passthrough request.

statusCode
integer
required

The resulting status code from the passthrough request.

headers
object
required

Any returned headers from the passthrough request.

response
object
required

The response body from the passthrough request