WIwithterminal
Data Management

Passthrough

Changed on

Make an authenticated request to the underlying telematics provider.

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.

post/passthrough

Request

  • Base URL
    https://api.withterminal.com/tsp/v1
  • URL
    https://api.withterminal.com/tsp/v1/passthrough
  • Auth
    HTTP bearer

Headers

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Request body

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required

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

pathstring required

A relative provider path such as /reports, or an absolute URL. Absolute URLs are accepted only when they target the connection's provider host.

headersobject

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

bodystring

The request body

Example request

{
  "method": "POST",
  "path": "/reports",
  "body": "{\"reportId\":\"1234\"}"
}

Response

OK

methodstring required

The HTTP method that was used when making the request.

pathstring required

The path that was called with the passthrough request.

statusCodeinteger required

The resulting status code from the passthrough request.

headersobject required

Any returned headers from the passthrough request.

Example response

{
  "method": "POST",
  "path": "/reports",
  "statusCode": 200,
  "headers": {
    "Content-Type": "application/json"
  }
}

Changes

  • 71081936e1bdRevision changes
    • breaking

      request body became required

    • warning

      added the new oauth_client_id_unknown enum value to the response property for the response status

    • warning

      added the new provider_timeout enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status