WIwithterminal
Providers

List Providers

Changed on

Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.

get/providers

Request

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

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Response

OK

namestring required
codestring required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

baseCodestring

The base provider code that this provider is built on. Only visible to authenticated users. Used to identify providers that share the same underlying technology platform.

status'live' | 'beta' | 'sandbox' | 'deprecated' required

The status of the provider.

logostring uri required
iconstring uri required

Example response

[
  {
    "name": "Geotab",
    "code": "geotab",
    "baseCode": "geotab",
    "logo": "https://cdn.withterminal.com/providers/geotab/logo.png",
    "icon": "https://cdn.withterminal.com/providers/geotab/icon.png",
    "supportedModels": {
      "VehicleLocation": {
        "sampleRate": "30 seconds",
        "availableHistory": "1 year"
      },
      "VehicleStatLog": {
        "types": [
          "odometer",
          "engine_state",
          "fuel_level",
          "engine_runtime"
        ]
      },
      "SafetyEvent": {
        "types": [
          "speeding",
          "harsh_brake",
          "harsh_acceleration",
          "harsh_turn",
          "crash"
        ]
      }
    }
  }
]

Changes

  • a9f825034fd3Revision changes
    • warning

      added the new password-reset enum value to the /// response property for the response status

  • 71081936e1bdRevision changes
    • warning

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