{ "openapi": "3.1.0", "info": { "title": "Terminal Telematics API", "description": "Terminal is a unified API that makes it easy to integrate with the leading telematics service providers.", "version": "0.0", "contact": { "name": "Terminal", "email": "connect@withterminal.com", "url": "https://www.withterminal.com" } }, "servers": [ { "url": "https://api.withterminal.com/tsp/v1", "description": "Production" }, { "url": "https://api.sandbox.withterminal.com/tsp/v1", "description": "Sandbox" } ], "paths": { "/public-token/exchange": { "post": { "summary": "Public Token Exchange", "operationId": "publicTokenExchange", "x-operation-category": "control-plane", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "description": "Exchange the `publicToken` returned by our hosted authentication flow for a long lived connection token that will be used when requesting data from a customer's TSP.", "tags": ["Authentication"], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "publicToken": { "$ref": "#/components/schemas/PublicToken" } }, "required": ["publicToken"] } } } } }, "x-mcp": { "enabled": true } }, "/applications": { "get": { "x-mcp": "all", "x-mcp-discovery": true, "x-hidden": true, "summary": "List Applications", "operationId": "listApplications", "x-operation-category": "control-plane", "description": "Returns a slim list of the applications the authenticated caller can access, scoped to their credential: a user sees every application in their active organization, an API key sees the single application it is bound to, and an internal admin sees all applications. Hidden from public docs and intended for MCP clients to select an applicationId without exposing sensitive application settings. MCP clients should call listApplications before application-scoped endpoints. If one application is returned, use it automatically; if multiple applications are returned, ask the user which application to use.", "tags": ["Applications"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["id", "name", "organizationId", "permissions"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "permissions": { "type": "array", "items": { "title": "Permission Scope", "type": "string", "enum": [ "group:read", "vehicle:read", "driver:read", "hos:read", "hos:available-time:read", "safety:read", "vehicle-location:read", "vehicle-location:latest:read", "vehicle-stats:read", "vehicle-stats:odometer:read", "vehicle-stats:total-fuel-consumption:read", "vehicle-stats:fuel-level:read", "vehicle-stats:engine-state:read", "vehicle-stats:engine-runtime:read", "vehicle-stats:engine-oil-percentage:read", "vehicle-stats:engine-oil-pressure:read", "vehicle-stats:engine-oil-temperature:read", "vehicle-stats:engine-coolant-temperature:read", "vehicle-stats:coolant-percentage:read", "vehicle-stats:engine-rpm:read", "vehicle-stats:battery-voltage:read", "vehicle-utilization:read", "ifta:read", "trailer:read", "trailer-location:latest:read", "trip:read", "device:read", "camera-media:read", "fault-codes:read" ], "description": "The permissions that an application can have with a connection. Please note this model is currently an internal concept. More information to come soon." } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" } } }, "x-mcp": { "enabled": true } }, "/link/short": { "post": { "summary": "Create Short Link URL", "operationId": "createShortLink", "x-operation-category": "control-plane", "description": "Create a short URL for the Link onboarding flow as an alternative to the full Link URL with all its query parameters.\n\nThe response contains a durable `id`, an 8-character `code`, and the full `url` to share with your user. Short links are valid for 1 year from creation.\n\nStore the `id` if you may need to delete the short link later. The public `code` / `url` alone cannot be used to revoke a link.\n\nIdentical request bodies are de-duplicated automatically. Calling this endpoint a second time with the same parameters returns the original short link (including its `id`) with an `Idempotent-Replayed: true` response header.", "tags": ["Link"], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "providerHints": { "type": "array", "description": "An optional list of provider codes to hoist to the top of the Link provider list.", "items": { "$ref": "#/components/schemas/ProviderCode" } }, "externalId": { "type": "string", "example": "fleet_456", "description": "An optional ID from your system that can be used to reference connections." }, "name": { "type": "string", "description": "An optional human-readable name to associate with the resulting connection." }, "tags": { "type": "array", "description": "An optional list of tags from your system that can be used to reference connections.", "items": { "type": "string", "example": "Tag Name" } }, "redirectUrl": { "type": "string", "format": "uri", "example": "https://app.acme.com/telematics-success", "description": "URL to redirect your user to after they complete the Link flow." }, "syncMode": { "$ref": "#/components/schemas/SyncMode" }, "backfill": { "additionalProperties": false, "description": "Optional backfill to be requested upon successful connection. Will start from NOW if not provided.", "type": "object", "properties": { "startFrom": { "$ref": "#/components/schemas/ISODateTime" }, "days": { "type": "number" } } }, "template": { "title": "LinkTemplateId", "description": "Unique identifier for the Link Template.", "type": "string", "format": "ulid", "example": "ltp_01HXQ4YK8V2X0X0X0X0X0X0X0X" } } } } } }, "responses": { "200": { "description": "OK", "headers": { "Idempotent-Replayed": { "schema": { "type": "boolean", "enum": [true] }, "description": "Always `true` on a 200 response. It indicates that an existing short link was returned instead of minting a new one." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortLink" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortLink" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } } }, "x-mcp": { "enabled": true } }, "/link/short/{id}": { "parameters": [ { "schema": { "$ref": "#/components/schemas/ShortLinkId" }, "name": "id", "in": "path", "required": true } ], "delete": { "summary": "Delete Short Link", "operationId": "deleteShortLink", "x-operation-category": "control-plane", "description": "Permanently delete a short link by its durable `id` from the create response (`slk_…`). This endpoint does not accept the 8-character `code` from the shared URL.\n\nAfter deletion, the short URL stops resolving immediately and the code may be reused by a future mint.", "tags": ["Link"], "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } } }, "x-mcp": { "enabled": true } }, "/ingestion/row-counts": { "get": { "x-mcp": "all", "summary": "List Row Counts", "tags": ["Data Management"], "x-hidden": true, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/RowCountEntry" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listRowCounts", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2021-01-06" }, "description": "Include records from on or after a specific date." }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2021-01-06" }, "description": "Include records from on or before a specific date." }, { "name": "groupBy", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/RowCountGroupBy" } }, { "name": "vehicleIds", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^vcl_[0-9A-HJKMNP-TV-Z]{26}(\\s*,\\s*vcl_[0-9A-HJKMNP-TV-Z]{26})*$" }, "description": "Comma separated list of vehicle IDs to filter by. Only supported for vehicle-based models. Each ID must use the `vcl_` prefix." }, { "name": "models", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma separated list of model names to include." }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" } ], "description": "Retrieve row counts by model for a connection. Omit groupBy for totals over the date range, use groupBy=day for daily rows, use groupBy=vehicle for per-vehicle totals, or combine both (for example groupBy=day,vehicle) for per-day, per-vehicle rows." }, "x-mcp": { "enabled": true } }, "/usage": { "get": { "x-mcp": "all", "summary": "List Usage", "operationId": "listUsage", "x-operation-category": "control-plane", "description": "List billable vehicle and backfill usage for an application by ISO month.", "tags": ["Usage"], "x-hidden": true, "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "name": "month", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "description": "ISO month in YYYY-MM format", "example": "2025-08" }, "description": "ISO month to retrieve usage for, in YYYY-MM format." }, { "$ref": "#/components/parameters/Cursor" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } } }, "x-mcp": { "enabled": true } }, "/vehicles": { "get": { "x-mcp": "all", "summary": "List Vehicles", "tags": ["Vehicles"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Vehicle" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listVehicles", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/Hidden" }, { "$ref": "#/components/parameters/Deleted" }, { "schema": { "type": "string", "enum": ["groups", "devices", "devices,groups", "groups,devices"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ], "description": "List all of the vehicles in the connected account" }, "parameters": [], "x-mcp": { "enabled": true } }, "/vehicles/{id}": { "parameters": [ { "schema": { "$ref": "#/components/schemas/VehicleId" }, "name": "id", "in": "path", "required": true } ], "get": { "x-mcp": "all", "summary": "Get Vehicle", "tags": ["Vehicles"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vehicle" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getVehicle", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" }, { "schema": { "type": "string", "enum": ["groups", "devices", "devices,groups", "groups,devices"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ], "description": "Get the details of a specific vehicle" }, "x-mcp": { "enabled": true } }, "/drivers": { "get": { "x-mcp": "all", "summary": "List Drivers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Driver" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listDrivers", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/Hidden" }, { "$ref": "#/components/parameters/Deleted" }, { "schema": { "type": "string", "enum": ["groups"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ], "tags": ["Drivers"], "description": "List all of the drivers in the connected account" }, "parameters": [], "x-mcp": { "enabled": true } }, "/drivers/{id}": { "parameters": [ { "schema": { "$ref": "#/components/schemas/DriverId" }, "name": "id", "in": "path", "required": true } ], "get": { "x-mcp": "all", "summary": "Get Driver", "tags": ["Drivers"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getDriver", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" }, { "schema": { "type": "string", "enum": ["groups"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ], "description": "Get the details of a specific driver" }, "x-mcp": { "enabled": true } }, "/hos/available-time": { "get": { "x-mcp": "all", "summary": "Available Time for Drivers", "tags": ["Hours of Service"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/HOSAvailableTime" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ProviderUnavailableError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listHOSAvailableTime", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/DriverIds" }, { "schema": { "type": "string", "enum": ["driver"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Raw" } ], "description": "List available time for the driver. This endpoint provides live access to the driver's available time. Different than most endpoints, this endpoint calls the provider's API in real time to get the latest available time for the driver. This endpoint is useful for building real time applications that need to know the driver's available time." }, "parameters": [], "x-mcp": { "enabled": true } }, "/hos/logs": { "get": { "x-mcp": "all", "summary": "List HOS Logs", "tags": ["Hours of Service"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/HOSLog" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listHOSLogs", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedAfter", "description": "Only include records of statuses that started after a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedBefore", "description": "Only include records of statuses that started before a provided date." }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/DriverIds" }, { "schema": { "type": "string", "enum": [ "driver", "vehicle", "codrivers", "driver,vehicle", "driver,codrivers", "vehicle,driver", "vehicle,codrivers", "codrivers,driver", "codrivers,vehicle", "driver,vehicle,codrivers", "driver,codrivers,vehicle", "vehicle,driver,codrivers", "vehicle,codrivers,driver", "codrivers,driver,vehicle", "codrivers,vehicle,driver" ] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Deleted" }, { "$ref": "#/components/parameters/Raw" } ], "description": "List all hours of service logs. HOS logs are tracked as the distinct changes in duty status." }, "parameters": [], "x-mcp": { "enabled": true } }, "/hos/daily-logs": { "get": { "x-mcp": "all", "summary": "List HOS Daily Logs", "tags": ["Hours of Service"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/HOSDailyLog" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listHOSDailyLogs", "x-operation-category": "core-data", "description": "List daily summary of hours of service. Each daily log represents the time a driver spent in each duty status for a given day.", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/StartDate" }, { "$ref": "#/components/parameters/EndDate" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/DriverIds" }, { "$ref": "#/components/parameters/Raw" }, { "schema": { "type": "string", "enum": [ "driver", "vehicles", "driver,vehicles", "vehicles,driver" ] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ] }, "parameters": [], "x-mcp": { "enabled": true } }, "/vehicles/locations": { "get": { "x-mcp": "all", "summary": "Latest Vehicle Locations", "tags": ["Vehicles"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/LatestVehicleLocation" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "503": { "$ref": "#/components/responses/ProviderUnavailableError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listLatestVehicleLocations", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/VehicleIds" }, { "$ref": "#/components/parameters/DriverIds" }, { "schema": { "type": "string", "enum": ["vehicle", "driver", "vehicle,driver", "driver,vehicle"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ], "description": "List the latest location of the vehicles in the connected account.\nThis endpoint will call the provider's API in real time to get the latest location of the vehicle. \n_Please note: this endpoint will exclude vehicles that have no last known location._" }, "parameters": [], "x-mcp": { "enabled": true } }, "/vehicles/{vehicleId}/locations": { "get": { "x-mcp": "all", "summary": "Historical Vehicle Locations", "tags": ["Vehicles"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleLocation" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "operationId": "listHistoricalVehicleLocations", "x-operation-category": "time-series", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/StartAt" }, { "$ref": "#/components/parameters/EndAt" }, { "$ref": "#/components/parameters/Raw" } ], "description": "List the historical breadcrumb locations for a vehicle.\n\n_Note:_\n\nGiven the large volume of location data available, we encourage customers to accept compressed (`gzip`) responses in order to maximize throughput. This is supported with many popular HTTP clients. Result limits vary depending on if results are compressed or not." }, "parameters": [ { "schema": { "$ref": "#/components/schemas/VehicleId" }, "name": "vehicleId", "in": "path", "required": true, "description": "Vehicle to retrieve breadcrumb locations for" } ], "x-mcp": { "enabled": true } }, "/vehicles/utilization": { "get": { "x-mcp": "all", "summary": "Get Vehicle Utilization", "tags": ["Vehicle Utilization"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleUtilization" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getVehicleUtilization", "x-operation-category": "time-series", "description": "Get vehicle utilization days containing information about fuel consumption, distance traveled, and operational time metrics.", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/StartDate" }, { "$ref": "#/components/parameters/EndDate" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/VehicleIds" }, { "schema": { "type": "string", "enum": ["vehicle"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Raw" } ] }, "x-mcp": { "enabled": true } }, "/vehicles/{vehicleId}/stats/historical": { "parameters": [ { "schema": { "$ref": "#/components/schemas/VehicleId" }, "name": "vehicleId", "in": "path", "required": true } ], "get": { "x-mcp": "all", "summary": "Historical Vehicle Stats", "tags": ["Vehicles"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleStatLog" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listHistoricalVehicleStats", "x-operation-category": "time-series", "description": "List historical stats and logs about the vehicle.", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "type": "string", "enum": ["vehicle"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/StartAt" }, { "$ref": "#/components/parameters/EndAt" }, { "schema": { "type": "string", "example": "odometer,engine_state,fuel_level,total_fuel_consumption" }, "in": "query", "name": "types", "description": "Comma separated list of vehicle stats to filter for", "required": false }, { "$ref": "#/components/parameters/Raw" } ] }, "x-mcp": { "enabled": true } }, "/trips": { "get": { "x-mcp": "all", "summary": "List Historical Trips", "description": "List all historical trips in the connected account. Trips define a period of time where a vehicle is in motion.", "tags": ["Trips"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Trip" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listTrips", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedAfter", "description": "Only include trips that started after a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedBefore", "description": "Only include trips that started before a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "endedAfter", "description": "Only include trips that ended after a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "endedBefore", "description": "Only include trips that ended before a provided date." }, { "$ref": "#/components/parameters/DriverIds" }, { "$ref": "#/components/parameters/VehicleIds" }, { "$ref": "#/components/parameters/Deleted" }, { "$ref": "#/components/parameters/Raw" }, { "schema": { "type": "string", "enum": ["vehicle", "driver", "driver,vehicle", "vehicle,driver"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" } ] }, "parameters": [], "x-mcp": { "enabled": true } }, "/devices": { "get": { "x-mcp": "all", "summary": "List Devices", "description": "List all devices in the connected account.", "tags": ["Devices"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listDevices", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/Deleted" }, { "name": "expand", "in": "query", "schema": { "type": "string", "enum": ["vehicle"] }, "description": "Expand resources in the returned response" } ] }, "parameters": [], "x-mcp": { "enabled": true } }, "/safety/events": { "get": { "x-mcp": "all", "summary": "List Safety Events", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SafetyEvent" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listSafetyEvents", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedAfter", "description": "Only include records of statuses that started after a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startedBefore", "description": "Only include records of statuses that started before a provided date." }, { "$ref": "#/components/parameters/DriverIds" }, { "$ref": "#/components/parameters/VehicleIds" }, { "schema": { "type": "string", "enum": ["vehicle", "driver", "driver,vehicle", "vehicle,driver"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Deleted" }, { "$ref": "#/components/parameters/Raw" } ], "tags": ["Safety"], "description": "List all safety events detected by the provider." }, "parameters": [], "x-mcp": { "enabled": true } }, "/safety/events/{id}": { "get": { "x-mcp": "all", "summary": "Get Safety Event", "tags": ["Safety"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEvent" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "operationId": "getSafetyEvent", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "schema": { "type": "string", "enum": ["driver", "vehicle", "driver,vehicle", "vehicle,driver"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Raw" } ], "description": "Get a safety event by id." }, "parameters": [ { "schema": { "$ref": "#/components/schemas/SafetyEventId" }, "name": "id", "in": "path", "required": true, "description": "The id of the safety event." } ], "x-mcp": { "enabled": true } }, "/safety/events/{id}/camera-media": { "get": { "x-mcp": "all", "summary": "Get Event Camera Media", "tags": ["Safety"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CameraMedia" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getEventCameraMedia", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" } ], "description": "Get camera media for a given safety event." }, "parameters": [ { "schema": { "$ref": "#/components/schemas/SafetyEventId" }, "name": "id", "in": "path", "required": true, "description": "The id of the safety event." } ], "x-mcp": { "enabled": true } }, "/groups": { "get": { "x-mcp": "all", "summary": "List Groups", "tags": ["Groups"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listGroups", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "type": "string", "enum": ["parent"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/Deleted" } ] }, "x-mcp": { "enabled": true } }, "/trailers": { "get": { "x-mcp": "all", "summary": "List Trailers", "tags": ["Trailers"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Trailer" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listTrailers", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "type": "string", "enum": ["groups"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "$ref": "#/components/parameters/Deleted" } ] }, "x-mcp": { "enabled": true } }, "/trailers/locations": { "get": { "x-mcp": "all", "summary": "Latest Trailer Locations", "tags": ["Trailers"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/LatestTrailerLocation" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listLatestTrailerLocations", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "type": "string", "enum": ["trailer"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" } ] }, "x-mcp": { "enabled": true } }, "/ifta/summary": { "get": { "x-mcp": "all", "summary": "Get IFTA Summary", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/IFTASummary" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getIFTASummary", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "type": "string", "enum": ["vehicle"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Raw" }, { "schema": { "$ref": "#/components/schemas/ISOMonth" }, "in": "query", "name": "startMonth", "description": "First month to include, inclusive.", "required": true }, { "schema": { "$ref": "#/components/schemas/ISOMonth" }, "in": "query", "name": "endMonth", "description": "Last month to include, inclusive.", "required": true }, { "schema": { "type": "string", "enum": [ "jurisdiction", "vehicle", "vehicle,jurisdiction", "vehicle,jurisdiction,month" ], "default": "vehicle,jurisdiction" }, "in": "query", "name": "groupBy", "description": "How to total distance across the requested months. The default, `vehicle,jurisdiction`, returns one row per vehicle and jurisdiction, summed across every month from `startMonth` to `endMonth`. Use `vehicle,jurisdiction,month` to get one row per month." } ], "tags": ["IFTA"], "description": "Get distance driven per IFTA jurisdiction for the requested months.\n\n_Note:_ data may change for a few days after the month. We will continue to update those reports to ensure you get accurate results." }, "parameters": [], "x-mcp": { "enabled": true } }, "/connections": { "get": { "x-mcp": "all", "summary": "List All Connections", "tags": ["Connections"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listConnections", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "type": "string" }, "in": "query", "name": "externalId" }, { "schema": { "type": "string" }, "in": "query", "name": "dotNumber" }, { "schema": { "type": "string" }, "in": "query", "name": "tag", "description": "Filter connections by tag" }, { "name": "updatedAfter", "in": "query", "schema": { "$ref": "#/components/schemas/ISODateTime" }, "description": "Filter connections that were last updated on or after a given time." }, { "name": "updatedBefore", "in": "query", "schema": { "$ref": "#/components/schemas/ISODateTime" }, "description": "Filter connections that were last updated on or before a given time." }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ConnectionStatus" }, "description": "Filter connections by status" }, { "name": "provider", "in": "query", "schema": { "$ref": "#/components/schemas/ProviderCode" }, "description": "Filter connections by provider" }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "asc" }, "description": "Sort order by id (which is monotonically increasing by creation time). `desc` returns the most recently created connections first." } ], "description": "List all of the connections you have for your application. Connections represent the authenticated access you have to your customer's TSP data." }, "parameters": [], "post": { "summary": "Create Connection", "operationId": "createConnection", "x-operation-category": "control-plane", "description": "Create a new connection via API. This endpoint can be used to provide a completely custom connection creation experience for your customers.\n\nFor most use cases we recommend using the [Link UI](/guides/terminal-link) to create connections.", "x-hidden": true, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "422": { "description": "Unprocessable Entity (WebDAV)", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_credentials", "oauth_client_id_unknown", "insufficient_permissions", "internal_server_error", "connection_error", "provider_unavailable" ] }, "message": { "type": "string" }, "detail": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "suggestion": { "type": "string" }, "context": { "type": "object" } }, "required": ["message"] } } }, "required": ["code", "message"] } } } }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "allOf": [ { "$ref": "#/components/schemas/ProviderCredentials" }, { "type": "object", "properties": { "company": { "type": "object", "properties": { "name": { "type": "string" }, "dotNumbers": { "type": "array", "items": { "type": "string" } } } }, "options": { "$ref": "#/components/schemas/ProviderOptions" }, "externalId": { "type": "string" }, "syncMode": { "$ref": "#/components/schemas/SyncMode" }, "backfill": { "additionalProperties": false, "description": "Optional backfill to be requested upon successful connection. Will start from NOW if not provided.", "type": "object", "properties": { "startFrom": { "$ref": "#/components/schemas/ISODateTime" }, "days": { "type": "number" } } }, "tags": { "type": "array", "items": { "type": "string", "example": "Tag Name" } }, "agreements": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementAcceptance" }, "description": "The agreements to link the connection to." } } } ] } } }, "description": "" }, "tags": ["Connections"] }, "x-mcp": { "enabled": true } }, "/connections/current": { "get": { "x-mcp": "all", "summary": "Get Current Connection", "tags": ["Connections"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/FullConnection" }, { "type": "object", "properties": { "lastSync": { "$ref": "#/components/schemas/Sync" }, "agreements": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } }, "required": ["agreements"] } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeletedConnection" }, { "type": "object", "properties": { "agreements": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } }, "required": ["agreements"] } ] } ] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getCurrentConnection", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" } ], "description": "Get the details of the current active connection. The current connection is derived from the provided connection token." }, "parameters": [], "patch": { "summary": "Update Current Connection", "operationId": "updateCurrentConnection", "x-operation-category": "control-plane", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "tags": ["Connections"], "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": ["connected", "archived", "disconnected"] }, "options": { "$ref": "#/components/schemas/ProviderOptions" }, "company": { "type": "object", "properties": { "name": { "type": "string", "example": "Acme Inc.", "description": "The name of the company." }, "dotNumbers": { "description": "DOT numbers associated with the company.", "type": "array", "items": { "type": "string" } } } }, "externalId": { "type": "string" }, "syncMode": { "$ref": "#/components/schemas/SyncMode" }, "tags": { "type": "array", "items": { "type": "string", "description": "Tags associated with the connection" } }, "filters": { "$ref": "#/components/schemas/ConnectionFilters" } } } } } }, "description": "Update the details of the current active connection. The current connection is derived from the provided connection token.\n\nAcross all lists, the maximum is about 8,000 IDs. A larger update is rejected with 422 and is not saved. If one list contains most vehicles or drivers, use the opposite list: excludeIds for the ones to skip, or includeIds for the ones to keep." }, "delete": { "operationId": "deleteCurrentConnection", "x-operation-category": "control-plane", "summary": "Delete Current Connection", "description": "Request permanent deletion of the current connection and its synced data. This endpoint updates the connection's status to `pending_deletion` and returns `202 Accepted`. Deletion will begin asynchronously after a grace period.", "tags": ["Connections"], "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } } }, "x-mcp": { "enabled": true } }, "/developer/replay-connection-creation": { "post": { "summary": "Replay Connection Creation (Developer)", "operationId": "replayConnectionCreation", "x-operation-category": "control-plane", "tags": ["Connections"], "x-hidden": true, "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplayConnectionCreationInput" } } }, "required": false }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "id": { "type": "string", "description": "The connection id that was replayed" } }, "required": ["message", "id"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "description": "Developer endpoint to replay onboarding webhook events for the current connection. You can choose which events to emit; omit the body to replay all applicable events (same as selecting every event type)." }, "x-mcp": { "enabled": true } }, "/syncs": { "post": { "summary": "Request Sync", "operationId": "requestSync", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sync" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ConflictError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "tags": ["Data Management"], "description": "Manually request to sync the current connections data.\n\nBy default, Terminal will sync all connections where `syncMode = automatic` on a regular cadence. For customers that may not need a fleet's data to be kept up to date and want to reduce their active tracked trucks, you can set `syncMode = manual` and invoke this endpoint when you want to sync data.\n\nIf you're wondering if this is relevent to your use case then feel free to reach out and we'd be happy to assist.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "How to sync the data. If `startFrom` is not provided, it will either sync from the last time a sync was requested or `now` if the connection has no sync history. Can also provide `days` instead of `startFrom` and it will be converted to a date and used in place of `startFrom`.", "properties": { "startFrom": { "$ref": "#/components/schemas/ISODateTime", "description": "When to start syncing from. If `startFrom` is not provided, it will either sync from the last time a sync was requested or `now` if the connection has no sync history." }, "days": { "type": "number", "description": "How many days of history to sync from `now`. Will be converted to a date and used in place of `startFrom`" }, "providerRequests": { "type": "array", "description": "Request additional information from the provider for this sync.", "example": [ { "type": "historical_files" } ], "items": { "$ref": "#/components/schemas/SyncProviderRequestType" } } }, "example": { "days": 7 } } } }, "description": "" } }, "get": { "x-mcp": "all", "summary": "List Sync History", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Sync" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listSyncHistory", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "$ref": "#/components/schemas/SyncStatus" }, "in": "query", "name": "status" }, { "schema": { "type": "string", "enum": ["issues"] }, "in": "query", "name": "expand", "description": "Expand related resources in the response to reduce requests." } ], "tags": ["Data Management"], "description": "List a log of all batch sync jobs for the current connection." }, "parameters": [], "x-mcp": { "enabled": true } }, "/syncs/{id}": { "get": { "x-mcp": "all", "summary": "Get Sync Job Status", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sync" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "getSyncJobStatus", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "schema": { "type": "string", "enum": ["issues"] }, "in": "query", "name": "expand", "description": "Expand related resources in the response to reduce requests." } ], "tags": ["Data Management"], "description": "Get the status of a sync job by ID." }, "parameters": [ { "schema": { "$ref": "#/components/schemas/SyncId" }, "name": "id", "in": "path", "required": true } ], "x-mcp": { "enabled": true } }, "/syncs/{id}/retry": { "parameters": [ { "schema": { "$ref": "#/components/schemas/SyncId" }, "name": "id", "in": "path", "required": true, "description": "The ID of the sync job to retry" } ], "post": { "summary": "Retry Sync", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/SyncId" }, "message": { "type": "string", "example": "Sync retry requested" } } } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "retrySync", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "tags": ["Data Management"], "description": "Retry a failed sync job with the same parameters. This is useful for retrying syncs that failed due to temporary issues." }, "x-mcp": { "enabled": true } }, "/syncs/{id}/cancel": { "parameters": [ { "schema": { "$ref": "#/components/schemas/SyncId" }, "name": "id", "in": "path", "required": true, "description": "The ID of the sync job to retry" } ], "post": { "summary": "Cancel Sync", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/SyncId" }, "message": { "type": "string", "example": "Sync cancellation requested" } } } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "cancelSync", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "tags": ["Data Management"], "description": "Cancel a sync job mid-way through. This is useful for cancelling syncs that are no longer needed. Cancelled syncs will be marked as failed and can be retried." }, "x-mcp": { "enabled": true } }, "/passthrough": { "post": { "x-mcp": "admin", "x-mcp-annotations": { "readOnlyHint": false, "destructiveHint": true, "idempotentHint": false, "openWorldHint": true }, "x-mcp-guidance": "APPROVAL REQUIRED: this tool sends an arbitrary request to the customer's telematics provider using their credentials. Any method, including GET, can trigger provider-side effects, rate limits, or billing. Before every call, show the user the exact method, path, headers, and body you intend to send and wait for their explicit approval. Never call this tool autonomously, in a loop, or as part of a batched task without per-request approval.", "summary": "Passthrough", "operationId": "passthrough", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PassthroughOutput" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "description": "Make an authenticated request to the underlying telematics provider. \n\nThis 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.\n\nOur team is here and ready to support custom use cases that may need `/passthrough`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PassthroughInput" } } } }, "tags": ["Data Management"] }, "parameters": [], "x-mcp": { "enabled": true } }, "/passthrough/raw": { "post": { "summary": "Raw Passthrough", "operationId": "passthroughRaw", "x-operation-category": "provider-action", "parameters": [ { "$ref": "#/components/parameters/ConnectionToken" } ], "responses": { "200": { "description": "A successful provider response body, forwarded directly without the Terminal `PassthroughOutput` JSON envelope. The `Content-Type` reflects the provider's response (for example `image/jpeg` or `application/pdf`), not necessarily `application/octet-stream`.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary", "description": "Raw response bytes from the provider. The body is not a JSON object and is not base64 encoded for HTTP clients. This endpoint may also return HTTP 200 with a `PassthroughOutput` JSON envelope (see the endpoint description) when the provider itself responds with an error status." } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "409": { "$ref": "#/components/responses/ProviderProvisioningPendingError" }, "410": { "$ref": "#/components/responses/GoneError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "501": { "$ref": "#/components/responses/NotImplementedError" }, "502": { "$ref": "#/components/responses/BadGatewayError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "description": "Make an authenticated request to the underlying telematics provider and forward successful provider response bodies directly.\n\nUse Raw Passthrough for provider endpoints that download inspection photos, documents, videos, or other non-JSON files.\n\nResponse rules:\n- **Provider success (2xx):** the provider body is returned as raw bytes with the provider's `Content-Type` and status.\n- **Provider error (non-2xx):** the response is HTTP `200` with a `PassthroughOutput` JSON envelope (`statusCode`, `headers`, `response`), matching `/passthrough`. Unsuccessful provider responses are therefore not surfaced as Terminal API errors; check the envelope's `statusCode` for the provider status.\n- **Terminal error:** requests that fail before or around the provider call return a standard Terminal error status and JSON body.\n\nFor normal JSON API calls where you want Terminal to parse and wrap successful provider responses too, use `/passthrough` instead.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PassthroughInput" }, "examples": { "downloadMediaFile": { "summary": "Download a media file", "value": { "method": "POST", "path": "/media/files/download", "body": "{\"fileId\":\"file_123\"}" } } } } } }, "tags": ["Data Management"] }, "parameters": [], "x-mcp": { "enabled": true } }, "/providers": { "get": { "x-mcp": "all", "summary": "List Providers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Provider" } } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listProviders", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" } ], "description": "Retrieve a list of the providers Terminal supports. This endpoint will grow to include additional details about the supported capabilities of each provider.", "tags": ["Providers"] }, "parameters": [], "x-mcp": { "enabled": true } }, "/issues": { "get": { "x-mcp": "all", "summary": "List Issues", "tags": ["Issues"], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listIssues", "x-operation-category": "control-plane", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/Cursor" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "lastReportedAfter", "description": "Timestamp to start when the issue was last observed" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "lastReportedBefore", "description": "Timestamp to end when the issue was last observed" }, { "schema": { "type": "string", "enum": ["connection"] }, "in": "query", "name": "expand", "description": "Expand related resources to see all details" }, { "schema": { "$ref": "#/components/schemas/ConnectionId" }, "in": "query", "name": "connectionId", "description": "Filter issues to a specific connection" }, { "schema": { "$ref": "#/components/schemas/IssueCode" }, "in": "query", "name": "errorCode", "description": "Filter issues to a specific semantic Issue code" }, { "schema": { "type": "string", "enum": ["ongoing", "resolved"] }, "in": "query", "name": "status", "description": "Filter issues to a specific status" } ], "description": "List all issues that have been observed by Terminal.\nIssues are generated when we observe something that may impact the completeness or accuracy of the data we provide but do not justify a full error.\nFor example, if we lack permissions for a specific resource or need to skip an item due to invalid data." }, "x-mcp": { "enabled": true } }, "/issues/{issueId}/resolve": { "parameters": [ { "schema": { "$ref": "#/components/schemas/IssueId" }, "name": "issueId", "in": "path", "required": true } ], "post": { "summary": "Resolve Issue", "description": "Mark an issue's status as `resolved` until the issue is observed again.", "tags": ["Issues"], "operationId": "resolveIssue", "x-operation-category": "control-plane", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Issue" } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "422": { "$ref": "#/components/responses/UnprocessableEntityError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "parameters": [] }, "x-mcp": { "enabled": true } }, "/fault-codes/events": { "get": { "x-mcp": "all", "summary": "List Fault Code Events", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/FaultCodeEvent" } }, "next": { "$ref": "#/components/schemas/PaginationCursor" } }, "required": ["results"] } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "410": { "$ref": "#/components/responses/GoneError" }, "429": { "$ref": "#/components/responses/TooManyRequestsError" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "504": { "$ref": "#/components/responses/GatewayTimeoutError" } }, "operationId": "listFaultCodeEvents", "x-operation-category": "core-data", "parameters": [ { "$ref": "#/components/parameters/XApplicationId" }, { "$ref": "#/components/parameters/ConnectionToken" }, { "$ref": "#/components/parameters/Cursor" }, { "$ref": "#/components/parameters/Limit" }, { "$ref": "#/components/parameters/ModifiedAfter" }, { "$ref": "#/components/parameters/ModifiedBefore" }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "startAt", "description": "Only include fault code events after a provided date." }, { "schema": { "$ref": "#/components/schemas/ISODateTime" }, "in": "query", "name": "endAt", "description": "Only include fault code events before a provided date." }, { "$ref": "#/components/parameters/VehicleIds" }, { "schema": { "type": "string", "enum": ["vehicle"] }, "in": "query", "name": "expand", "description": "Expand resources in the returned response" }, { "$ref": "#/components/parameters/Raw" } ], "tags": ["Fault Codes"], "description": "List all fault code events detected by the provider." }, "parameters": [], "x-mcp": { "enabled": true } } }, "components": { "schemas": { "ReplayConnectionCreationInput": { "type": "object", "additionalProperties": false, "properties": { "events": { "type": "array", "description": "Which onboarding webhook events to replay, in logical order when multiple are selected. When omitted, all applicable events are replayed.", "items": { "type": "string", "enum": [ "connection.created", "connection.completed", "connection.first_sync_completed" ] }, "uniqueItems": true } } }, "ProviderCredentials": { "type": "object", "discriminator": { "propertyName": "provider" }, "oneOf": [ { "title": "24HOS ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["24hos-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "3MD ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["3md"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "3PL TEK", "type": "object", "properties": { "provider": { "type": "string", "enum": ["3pl-tek"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "888 ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["888-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ABC ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["abc-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Action ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["action-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ADA ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ada-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Advantage Knights ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["advantage-knights-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Advantage One", "type": "object", "properties": { "provider": { "type": "string", "enum": ["advantage-one"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ADX Fleet ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["adx-fleet-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "AFS World ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["afs-world-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "AI ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ai-eld"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "AirELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["aireld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "AirIQ", "type": "object", "properties": { "provider": { "type": "string", "enum": ["airiq"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Alfa ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["alfa-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Allways Track", "type": "object", "properties": { "provider": { "type": "string", "enum": ["allways-track"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Alpha E-Logbook", "type": "object", "properties": { "provider": { "type": "string", "enum": ["alpha-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Amber ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["amber-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "AMPM ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ampm-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Apex ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["apex-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Apex Ultima", "type": "object", "properties": { "provider": { "type": "string", "enum": ["apex-ultima"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Apollo", "type": "object", "properties": { "provider": { "type": "string", "enum": ["apollo"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Apollo Compass", "type": "object", "properties": { "provider": { "type": "string", "enum": ["apollo-compass"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Apollo ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["apollo-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Argos Connected Solutions", "type": "object", "properties": { "provider": { "type": "string", "enum": ["argos"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ASAP ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["asap-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "AT ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["at-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Attrix", "type": "object", "properties": { "provider": { "type": "string", "enum": ["attrix"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "AUTOGRI ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["autogri-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Avanguard ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["avanguard-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "AWA ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["awa-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "AwareGPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["aware-gps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Axion Route", "type": "object", "properties": { "provider": { "type": "string", "enum": ["mgk-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Azuga", "type": "object", "properties": { "provider": { "type": "string", "enum": ["azuga"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "BigRoad", "type": "object", "properties": { "provider": { "type": "string", "enum": ["bigroad"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Bison Elog", "type": "object", "properties": { "provider": { "type": "string", "enum": ["bison-elog"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Black Bear", "type": "object", "properties": { "provider": { "type": "string", "enum": ["black-bear"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Blue Arrow Telematics", "type": "object", "properties": { "provider": { "type": "string", "enum": ["blue-arrow"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Blue Horse ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["blue-horse-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Blue Ink Tech", "type": "object", "properties": { "provider": { "type": "string", "enum": ["blue-ink"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Blue Star ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["blue-star-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "BST ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["bst-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Captain ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["captain-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ClearPathGPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["clear-path-gps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Club ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["club-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Clutch ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["clutch-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Cobra ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["cobra-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "CoGo ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["cogo-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Columbus ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["columbus-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "CommandGPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["command-gps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Conti-GO", "type": "object", "properties": { "provider": { "type": "string", "enum": ["conti-go"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Coretex", "type": "object", "properties": { "provider": { "type": "string", "enum": ["coretex-360"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Counting Trucks", "type": "object", "properties": { "provider": { "type": "string", "enum": ["counting-trucks"] }, "credentials": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1, "description": "API Token" } }, "required": ["token"] } }, "required": ["provider", "credentials"] }, { "title": "Daily ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["daily-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Daily ELD Plus", "type": "object", "properties": { "provider": { "type": "string", "enum": ["daily-eld-plus"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Dashboard ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dashboard-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Delta Solutions ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["delta-solutions-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "DFL ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dfl-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "DIALOG ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dialog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Digital ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["digital-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "DLog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dlog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Dragon ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dragon-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Dream ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dream-eld"] }, "credentials": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1 }, "companyName": { "type": "string", "minLength": 1 } }, "required": ["companyId", "companyName"] } }, "required": ["provider", "credentials"] }, { "title": "Dreyev", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dreyev"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "DriverBook", "type": "object", "properties": { "provider": { "type": "string", "enum": ["driverbook"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "DriveSafe ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["drive-safe-eld"] }, "credentials": { "type": "object", "properties": { "sourceId": { "type": "string", "minLength": 1 } }, "required": ["sourceId"] } }, "required": ["provider", "credentials"] }, { "title": "DSG Elogs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dsg-elogs"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "DY ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dy-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "DY+ ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dyplus-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Dynamic ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["dynamic-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "E-Log by ETM", "type": "object", "properties": { "provider": { "type": "string", "enum": ["etm-elog"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Eagle Wireless", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eagle-wireless"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "eBlue Sun Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eblue-sun-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Egreen ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["egreen-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Egreen ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["egreen-eld-v2"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Books", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-books"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Connection", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-connection"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Desired", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-desired"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD for You", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-for-you"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Mandate", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-mandate"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Mandate HOS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-mandate-hos"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Mandate Plus", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-mandate-plus"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Mandate Prime", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-mandate-prime"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Mandate Pro", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-mandate-pro"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD One", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eldone"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Pro Solution", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-pro-solution"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD Rider", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-rider"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD2GO", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld-2-go"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD4Trucking", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld4trucking"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELD88", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld88"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "ELD99", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld99"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Eld995", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eld995"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELDRoad", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eldroad"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ELDTREX", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eldtrex"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Elog42", "type": "object", "properties": { "provider": { "type": "string", "enum": ["elog42"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Empire Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["empire-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ensi Log", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ensi-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Enterprise ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["enterprise-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Envision ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["envision-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "EnVue Telematics", "type": "object", "properties": { "provider": { "type": "string", "enum": ["envue-telematics"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "EquipmentShare", "type": "object", "properties": { "provider": { "type": "string", "enum": ["equipmentshare"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "EROAD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eroad"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "EVA ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eva-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "EVO ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["evo-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Express Way ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["express-way-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Extreme ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["extreme-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ezlogz", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ez-logz"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "EzToTrack", "type": "object", "properties": { "provider": { "type": "string", "enum": ["eztotrack"] }, "credentials": { "type": "object", "properties": { "clientKey": { "type": "string", "minLength": 1, "description": "Client Key" } }, "required": ["clientKey"] } }, "required": ["provider", "credentials"] }, { "title": "Factor ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["factor-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Factor ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["factor-eld-v2"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "First ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["first-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "FIRSTGATE ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["firstgate-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Five ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["five-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Flash ELogs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["flash-elogs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Fleet Complete Hub", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleet-complete-hub"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Fleet Profit Center", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleet-profit-center"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Fleet Track", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleet-track"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FleetHunt", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleethunt"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Fleetistics", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleetistics"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FleetPulse", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleet-pulse"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FleetSharp", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleetsharp"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FleetVision", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fleetvision"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FLEX ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["flex-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "FM ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fm-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Force Fleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["force-fleet"] }, "credentials": { "oneOf": [ { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "code": { "type": "string", "description": "Authorization Code" }, "code_verifier": { "description": "PKCE code verifier used for authorization code exchange", "type": "string" } }, "required": ["client_id", "code"], "additionalProperties": {}, "description": "Authorization Code" }, { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "refresh_token": { "type": "string", "description": "Refresh Token" } }, "required": ["client_id", "refresh_token"], "additionalProperties": {}, "description": "Refresh Token" } ] } }, "required": ["provider", "credentials"] }, { "title": "Fort Knox ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fort-knox"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Fortune ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["fortune-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Forza ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["forza-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Geoforce", "type": "object", "properties": { "provider": { "type": "string", "enum": ["geoforce"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" }, "apiSecret": { "type": "string", "minLength": 1, "description": "API Secret" } }, "required": ["apiKey", "apiSecret"] } }, "required": ["provider", "credentials"] }, { "title": "Geotab", "type": "object", "properties": { "provider": { "type": "string", "enum": ["geotab"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Geotab AT&T", "type": "object", "properties": { "provider": { "type": "string", "enum": ["geotab-att"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Geothentic", "type": "object", "properties": { "provider": { "type": "string", "enum": ["geothentic"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "Globcom ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["globcom-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GoFleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gofleet"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GoGPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gogps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Good Deal GPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["good-deal-gps"] }, "credentials": { "type": "object", "properties": { "clientKey": { "type": "string", "minLength": 1, "description": "Client Key" } }, "required": ["clientKey"] } }, "required": ["provider", "credentials"] }, { "title": "Gorilla Safety", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gorilla-safety"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GPS Insight", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gps-insight"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GPS Tracking Canada", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gps-tracking-canada"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GPS Trackit", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gps-trackit"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "GPSTab", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gpstab"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Grand ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["grand-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GrayBox Solutions", "type": "object", "properties": { "provider": { "type": "string", "enum": ["graybox-solutions"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Green Light ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["green-light-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Gridline", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gridline"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "GT ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["gt-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Hapn", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hapn"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "HCSS eLogs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hcss"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Hero ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hero-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "High Point GPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["high-point-gps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Highest ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["highest-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Hive ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hive-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Horizon ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["horizon-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "HOS Reporter Plus", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hos-reporter-plus"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "HOS247", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hos247"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Hunter ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["hunter-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "ID ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["id-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ILog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ilog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ILog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ilog-eld-v2"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Infinity ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["infinity-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Inspire ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["inspire-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "IntelliShift", "type": "object", "properties": { "provider": { "type": "string", "enum": ["intelli-shift"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Interstate Freeway", "type": "object", "properties": { "provider": { "type": "string", "enum": ["interstate-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Intime ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["intime-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "IoTab", "type": "object", "properties": { "provider": { "type": "string", "enum": ["io-tab"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ironman ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ironman-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ISAAC Instruments", "type": "object", "properties": { "provider": { "type": "string", "enum": ["isaac"] }, "credentials": { "oneOf": [ { "title": "IsaacSigningCredentials", "type": "object", "properties": { "companyName": { "type": "string", "title": "Company Name", "minLength": 1 }, "applicationName": { "type": "string", "title": "Application Name", "minLength": 1 }, "programName": { "type": "string", "title": "Program Name", "minLength": 1 }, "name": { "type": "string", "title": "Name", "minLength": 1 }, "ctNumber": { "type": "string", "title": "CT Number", "minLength": 1 }, "email": { "type": "string", "title": "Email", "minLength": 1 }, "date": { "type": "string", "title": "Date", "minLength": 1 }, "documentUrl": { "type": "string", "title": "Document URL", "format": "uri" }, "submissionId": { "type": "number", "title": "DocuSeal Submission ID" } }, "required": [ "companyName", "applicationName", "programName", "name", "ctNumber", "email", "date", "documentUrl" ] }, { "title": "IsaacIntegrationCredentials", "type": "object", "properties": { "username": { "type": "string", "title": "Integration Username", "minLength": 1 }, "password": { "type": "string", "title": "Integration Password", "minLength": 1 }, "authCode": { "type": "string", "title": "Authorization Code", "format": "password", "minLength": 1 } }, "required": ["username", "password", "authCode"] } ] } }, "required": ["provider", "credentials"] }, { "title": "JJ Keller", "type": "object", "properties": { "provider": { "type": "string", "enum": ["jj-keller"] }, "credentials": { "oneOf": [ { "title": "JJKellerDataSharingAgreementCredentials", "type": "object", "properties": { "entityName": { "type": "string", "title": "Entity Name", "minLength": 1 }, "applicationName": { "type": "string", "title": "Application Name", "minLength": 1 }, "contactName": { "type": "string", "title": "Contact Name", "minLength": 1 }, "contactEmail": { "type": "string", "title": "Contact Email", "minLength": 1 }, "mailingAddress": { "type": "string", "title": "Mailing Address", "minLength": 1 }, "signature": { "type": "string", "title": "Signature", "format": "uri" }, "name": { "type": "string", "title": "Name", "minLength": 1 }, "date": { "type": "string", "title": "Date", "minLength": 1 }, "email": { "type": "string", "title": "Email", "minLength": 1 }, "documentUrl": { "type": "string", "title": "Document URL", "format": "uri" }, "submissionId": { "type": "number", "title": "DocuSeal Submission ID" }, "dotNumber": { "type": "string", "title": "DOT Number", "minLength": 1 }, "phoneNumber": { "type": "string", "title": "Phone Number", "minLength": 1 } }, "required": [ "entityName", "applicationName", "contactName", "contactEmail", "mailingAddress", "signature", "name", "date", "email", "documentUrl" ] }, { "title": "JJKellerIntegrationCredentials", "type": "object", "properties": { "username": { "type": "string", "title": "API Username", "minLength": 1 }, "password": { "type": "string", "title": "API Password", "format": "password", "minLength": 1 } }, "required": ["username", "password"] } ] } }, "required": ["provider", "credentials"] }, { "title": "Just ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["just-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Kinexa", "type": "object", "properties": { "provider": { "type": "string", "enum": ["kinexa"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Konexial", "type": "object", "properties": { "provider": { "type": "string", "enum": ["konexial"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["username", "password", "apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "KSK ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ksk"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Leader ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["leader-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Legacy ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["legacy-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Level ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["level-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Light & Travel ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["light-and-travel-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Linxup", "type": "object", "properties": { "provider": { "type": "string", "enum": ["linxup"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Log Plus ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["log-plus-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Logfleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["logfleet"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "LOOKTRUCK ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["looktruck-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "loopELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["loop-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Lucid ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["lucid-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Luna ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["luna-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Lytx", "type": "object", "properties": { "provider": { "type": "string", "enum": ["lytx"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Lytx One", "type": "object", "properties": { "provider": { "type": "string", "enum": ["lytx-one"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Maestral ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["maestral-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Map ELOG Corp", "type": "object", "properties": { "provider": { "type": "string", "enum": ["map-elog-corp"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Masana ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["masana-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "MasterELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["master-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Matrack", "type": "object", "properties": { "provider": { "type": "string", "enum": ["matrack"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "MAX ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["max-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "MDM ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["mdm-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "MICHELIN Connected Fleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["michelin-connected-fleet"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "accountId": { "type": "string", "minLength": 1, "description": "Account ID" } }, "required": ["username", "password", "accountId"] } }, "required": ["provider", "credentials"] }, { "title": "Monarch Tracking", "type": "object", "properties": { "provider": { "type": "string", "enum": ["monarch-tracking"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Monster ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["monster-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Moonlight ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["moonlight-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Motion ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["motion-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Motion ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["motion-eld-v2"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Motive", "type": "object", "properties": { "provider": { "type": "string", "enum": ["motive"] }, "credentials": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "code": { "type": "string", "description": "Authorization Code" }, "code_verifier": { "description": "PKCE code verifier used for authorization code exchange", "type": "string" } }, "required": ["client_id", "code"], "additionalProperties": {}, "description": "Authorization Code" }, { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "refresh_token": { "type": "string", "description": "Refresh Token" } }, "required": ["client_id", "refresh_token"], "additionalProperties": {}, "description": "Refresh Token" } ] }, { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"], "additionalProperties": {} } ] } }, "required": ["provider", "credentials"] }, { "title": "MOTOsafety", "type": "object", "properties": { "provider": { "type": "string", "enum": ["moto-safety"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Mountain ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["mountain-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "MyWay ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["myway-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "NEO ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["neo-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Netradyne", "type": "object", "properties": { "provider": { "type": "string", "enum": ["netradyne"] }, "credentials": { "type": "object", "properties": { "tenantName": { "type": "string", "minLength": 1, "description": "Fleet Unique Identifier" }, "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["tenantName"] } }, "required": ["provider", "credentials"] }, { "title": "New ELD World", "type": "object", "properties": { "provider": { "type": "string", "enum": ["new-eld-world"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Nexar", "type": "object", "properties": { "provider": { "type": "string", "enum": ["nexar"] }, "credentials": { "type": "object", "properties": { "userId": { "type": "string", "minLength": 1, "description": "User ID" } }, "required": ["userId"] } }, "required": ["provider", "credentials"] }, { "title": "Next Fleet ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["next-fleet-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "NexTraq", "type": "object", "properties": { "provider": { "type": "string", "enum": ["nextraq"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Night Watch ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["night-watch-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Noor ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["noor-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Novio ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["novio-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Nuuk", "type": "object", "properties": { "provider": { "type": "string", "enum": ["nuuk"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Omega ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["omega-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Omnitracs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["omnitracs"] }, "credentials": { "type": "object", "properties": { "companyId": { "description": "Company ID", "type": "string" }, "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Omnitracs ES", "type": "object", "properties": { "provider": { "type": "string", "enum": ["omnitracs-es"] }, "credentials": { "type": "object", "properties": { "companyId": { "description": "Company ID", "type": "string" }, "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Omnitracs OT1", "type": "object", "properties": { "provider": { "type": "string", "enum": ["omnitracs-ot1"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Omnitracs XRS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["omnitracs-xrs"] }, "credentials": { "type": "object", "properties": { "companyId": { "type": "string", "minLength": 1, "description": "Company ID" }, "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["companyId", "username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "One Source EW ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["one-source-ew-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "One System ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["one-system-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "OneStep GPS", "type": "object", "properties": { "provider": { "type": "string", "enum": ["one-step-gps"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Onroad ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["onroad-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Ontime ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ontime-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Optima ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["optima-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Orient ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["orient-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Orient Star ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["orient-star-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Orion ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["orion-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ozod Express ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ozod-express-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Panda ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["panda-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Paragon ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["paragon-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PDSINC ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pdsinc-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Peak ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["peak-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Pedigree OneView", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pedigree-oneview"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PeopleNet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["people-net"] }, "credentials": { "oneOf": [ { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "PeopleNet Company ID" }, "password": { "type": "string", "minLength": 1, "description": "PeopleNet Password" } }, "required": ["username", "password"] }, { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "PeopleNet Company ID" }, "password": { "type": "string", "minLength": 1, "description": "PeopleNet Password" }, "trimbleUsername": { "type": "string", "minLength": 1, "description": "Trimble Username" }, "trimblePassword": { "type": "string", "minLength": 1, "description": "Trimble Password" } }, "required": [ "username", "password", "trimbleUsername", "trimblePassword" ] } ] } }, "required": ["provider", "credentials"] }, { "title": "Phantom ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["phantom-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Phoenix ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["phoenix-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Pioneer ELD Solution", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pioneer-eld-solution"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Platinum ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["platinum-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PoP ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pop-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PowerTrucks ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["powertrucks-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PremierRide Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["premierride-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Premium ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["premium-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Prestige ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["prestige-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Pro Ride ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pro-ride-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Project ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["project-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "ProLogs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["prologs"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "ProTracking ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["protracking-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "PTI ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["pti-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Quantum ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["quantum-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Quartix", "type": "object", "properties": { "provider": { "type": "string", "enum": ["quartix"] }, "credentials": { "type": "object", "properties": { "customerId": { "type": "string", "minLength": 1, "description": "Customer/Subscriber ID" }, "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "application": { "type": "string", "minLength": 1, "description": "Application" } }, "required": [ "customerId", "username", "password", "application" ] } }, "required": ["provider", "credentials"] }, { "title": "Quick Elogs ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["quick-elogs-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Radical ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["radical-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Radius Telematics", "type": "object", "properties": { "provider": { "type": "string", "enum": ["radius-telematics"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rand McNally", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rand-mcnally"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rand McNally DriverConnect", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rand-mcnally-driver-connect"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rand McNally ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rand-mcnally-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rand Platform", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rand-platform"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Raven Connected", "type": "object", "properties": { "provider": { "type": "string", "enum": ["raven-connected"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" }, "apiSecret": { "type": "string", "minLength": 1, "description": "API Secret" } }, "required": ["apiKey", "apiSecret"] } }, "required": ["provider", "credentials"] }, { "title": "ReadySet Papeld", "type": "object", "properties": { "provider": { "type": "string", "enum": ["readyset-pap-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "RealELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["real-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "RedFox ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["redfox-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Regulog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["regulog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Reliable ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["reliable-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Remax ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["remax-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Renaissance ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["renaissance-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ridehub ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ridehub-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rigbot", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rigbot"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" }, "usdotId": { "type": "string", "minLength": 1, "description": "USDOT Number" } }, "required": ["apiKey", "usdotId"] } }, "required": ["provider", "credentials"] }, { "title": "Right Trucking", "type": "object", "properties": { "provider": { "type": "string", "enum": ["right-trucking"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Ring ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["ring-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "RoadReady Solutions", "type": "object", "properties": { "provider": { "type": "string", "enum": ["roadready-solutions"] }, "credentials": { "type": "object", "properties": { "geokey": { "type": "string", "minLength": 1, "description": "API Key (geokey)" } }, "required": ["geokey"] } }, "required": ["provider", "credentials"] }, { "title": "RoadStar", "type": "object", "properties": { "provider": { "type": "string", "enum": ["roadstar"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Robinhood ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["robinhood-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rock ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rock-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Rooya", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rooya"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Route ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["route-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Route One GO", "type": "object", "properties": { "provider": { "type": "string", "enum": ["route-one-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "RouteMate", "type": "object", "properties": { "provider": { "type": "string", "enum": ["routemate"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Royal ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["royal-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "RTE Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["rte-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Run ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["run-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Safe Lane ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["safe-lane-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "SAFER ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["safer-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Samsara", "type": "object", "properties": { "provider": { "type": "string", "enum": ["samsara"] }, "credentials": { "oneOf": [ { "oneOf": [ { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "code": { "type": "string", "description": "Authorization Code" }, "code_verifier": { "description": "PKCE code verifier used for authorization code exchange", "type": "string" } }, "required": ["client_id", "code"], "additionalProperties": {}, "description": "Authorization Code" }, { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "refresh_token": { "type": "string", "description": "Refresh Token" } }, "required": ["client_id", "refresh_token"], "additionalProperties": {}, "description": "Refresh Token" } ] }, { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"], "additionalProperties": {} } ] } }, "required": ["provider", "credentials"] }, { "title": "Sandbox", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sandbox"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "SBA ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sba-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Secure Path ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["secure-path-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "SF ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sf-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Sharp ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sharp-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Shelby ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["shelby-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Simba ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["simba-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Simple Way ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["simpleway-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Simplex ELD2Go", "type": "object", "properties": { "provider": { "type": "string", "enum": ["simplex"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Smart Choice Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["smart-choice-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Smart eLog", "type": "object", "properties": { "provider": { "type": "string", "enum": ["smart-elog"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "SmartDrive", "type": "object", "properties": { "provider": { "type": "string", "enum": ["smart-drive"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Smartelds", "type": "object", "properties": { "provider": { "type": "string", "enum": ["smartelds"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Solution ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["solution-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Sparkle ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sparkle-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Speedline ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["speedline-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Spireon", "type": "object", "properties": { "provider": { "type": "string", "enum": ["spireon"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Spireon FleetLocate", "type": "object", "properties": { "provider": { "type": "string", "enum": ["spireon-fleet-locate"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Spireon FleetLocate Transportation", "type": "object", "properties": { "provider": { "type": "string", "enum": ["spireon-fleet-locate-transportation"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Split ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["split-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Sprint ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sprint-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "SR ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sr-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Startrucks ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["startrucks-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Starway ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["starway-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "State ELOG", "type": "object", "properties": { "provider": { "type": "string", "enum": ["state-elog"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "State ELOG Beta", "type": "object", "properties": { "provider": { "type": "string", "enum": ["state-elog-v2"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Stellar ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["stellar-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "SUN ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sun-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" }, "usdot": { "type": "string", "minLength": 1, "description": "USDOT Number" } }, "required": ["apiKey", "usdot"] } }, "required": ["provider", "credentials"] }, { "title": "SUNRISER ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sunriser-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Sunset Logbook", "type": "object", "properties": { "provider": { "type": "string", "enum": ["sunset-logbook"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Support ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["support-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Surfsight", "type": "object", "properties": { "provider": { "type": "string", "enum": ["surfsight"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Swift ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["swift-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Switchboard", "type": "object", "properties": { "provider": { "type": "string", "enum": ["switchboard"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Synergy ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["synergy-eld"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "T-Mobile SyncUP", "type": "object", "properties": { "provider": { "type": "string", "enum": ["t-mobile-sync-up"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Teddy ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["teddy-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Teletrac Navman", "type": "object", "properties": { "provider": { "type": "string", "enum": ["teletrac-navman"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Teletrac Navman 360", "type": "object", "properties": { "provider": { "type": "string", "enum": ["teletrac-navman-360"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Teletrac Navman Director", "type": "object", "properties": { "provider": { "type": "string", "enum": ["teletrac-navman-director"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Tempus ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["tempus-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Tenna", "type": "object", "properties": { "provider": { "type": "string", "enum": ["tenna"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TFM ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["tfm-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Top Compliance ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["top-compliance-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Top Tracking System", "type": "object", "properties": { "provider": { "type": "string", "enum": ["top-tracking-system"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Track Truck ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["track-truck-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Track Your Truck", "type": "object", "properties": { "provider": { "type": "string", "enum": ["track-your-truck"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Trackease", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trackease"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TrackEnsure", "type": "object", "properties": { "provider": { "type": "string", "enum": ["track-ensure"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Trackmile", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trackmile"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "companyId": { "description": "Company ID", "type": "string", "minLength": 1 } }, "required": ["username", "password", "companyId"] } }, "required": ["provider", "credentials"] }, { "title": "TrackPro ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trackpro-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Traclog ELD Solutions", "type": "object", "properties": { "provider": { "type": "string", "enum": ["traclog-eld-solutions"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Transflo", "type": "object", "properties": { "provider": { "type": "string", "enum": ["transflo"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "database": { "type": "string", "minLength": 1, "description": "Database" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Transit ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["transit-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Transit Tracking ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["transit-tracking-eld"] }, "credentials": { "type": "object", "properties": { "clientKey": { "type": "string", "minLength": 1, "description": "Client Key" } }, "required": ["clientKey"] } }, "required": ["provider", "credentials"] }, { "title": "Trendy ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trendy-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Trimble", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trimble"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Trip ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trip-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Truckford ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["truckford-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Truckstaff ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["truckstaff-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TruckX", "type": "object", "properties": { "provider": { "type": "string", "enum": ["truckx"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "True Road ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["true-road-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Trust ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["trust-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TT ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["tt-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TX ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["tx-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "TXT DashCam", "type": "object", "properties": { "provider": { "type": "string", "enum": ["txt-dashcam"] }, "credentials": { "type": "object", "properties": { "tenantId": { "type": "string", "minLength": 1, "description": "Tenant ID" }, "sign": { "type": "string", "minLength": 1, "description": "Sign" } }, "required": ["tenantId", "sign"] } }, "required": ["provider", "credentials"] }, { "title": "TXT ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["txt-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Under Control ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["under-control-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Unique ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["unique-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Unity ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["unity-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "US Power ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["uspower-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "USfast ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["usfast-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "UzbPrime ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["uzbprime-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Vector ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vector-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Verizon Connect", "type": "object", "properties": { "provider": { "type": "string", "enum": ["verizon"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "companyName": { "description": "Company Name", "type": "string", "minLength": 1 }, "companyDotNumber": { "description": "DOT Number", "type": "number", "minimum": 1 } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Verizon Connect Fleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["verizon-fleet"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Verizon Connect Reveal", "type": "object", "properties": { "provider": { "type": "string", "enum": ["verizon-reveal"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" }, "companyName": { "description": "Company Name", "type": "string", "minLength": 1 }, "companyDotNumber": { "description": "DOT Number", "type": "number", "minimum": 1 } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Vista ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vista-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Vitality ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vitality-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Vlog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vlog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "VRD Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vrd-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "VRH ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vrh-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Vulcansols", "type": "object", "properties": { "provider": { "type": "string", "enum": ["vulcansols"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "WBCS Group LLC", "type": "object", "properties": { "provider": { "type": "string", "enum": ["secure-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Webfleet", "type": "object", "properties": { "provider": { "type": "string", "enum": ["webfleet"] }, "credentials": { "type": "object", "properties": { "accountName": { "type": "string", "minLength": 1, "description": "Account Name" }, "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["accountName", "username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Wex Telematics", "type": "object", "properties": { "provider": { "type": "string", "enum": ["wex-telematics"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Wheels eLog", "type": "object", "properties": { "provider": { "type": "string", "enum": ["wheels-elog"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Wizefleet ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["wizefleet-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "XELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["xeld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Xpert Logs", "type": "object", "properties": { "provider": { "type": "string", "enum": ["xpert-logs"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Xplore ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["xplore-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "YouLog ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["youlog-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zaphira ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zaphira-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zenduit Zendu One", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zenduit"] }, "credentials": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "description": "Client ID" }, "clientSecret": { "type": "string", "minLength": 1, "description": "Client Secret" } }, "required": ["clientId", "clientSecret"] } }, "required": ["provider", "credentials"] }, { "title": "Zenith ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zenith-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zero ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zero-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zeromax ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zeromax-eld"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] }, { "title": "Zippy ELD", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zippy-eld"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Email" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zonar Ground Traffic Control", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zonar"] }, "credentials": { "type": "object", "properties": { "username": { "type": "string", "minLength": 1, "description": "Username" }, "password": { "type": "string", "minLength": 1, "description": "Password" } }, "required": ["username", "password"] } }, "required": ["provider", "credentials"] }, { "title": "Zonar Ignition", "type": "object", "properties": { "provider": { "type": "string", "enum": ["zonar-ignition"] }, "credentials": { "type": "object", "properties": { "apiKey": { "type": "string", "minLength": 1, "description": "API Key" } }, "required": ["apiKey"] } }, "required": ["provider", "credentials"] } ] }, "Provider": { "title": "Provider", "type": "object", "properties": { "name": { "type": "string", "example": "Geotab" }, "code": { "$ref": "#/components/schemas/ProviderCode" }, "baseCode": { "type": "string", "example": "geotab", "description": "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": { "title": "ProviderStatus", "type": "string", "enum": ["live", "beta", "sandbox", "deprecated"], "description": "The status of the provider." }, "logo": { "type": "string", "format": "uri", "example": "https://cdn.withterminal.com/providers/geotab/logo.png" }, "icon": { "type": "string", "format": "uri", "example": "https://cdn.withterminal.com/providers/geotab/icon.png" }, "references": { "type": "array", "description": "Additional reference links for the provider (e.g., login pages)", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["login-page", "developer-docs"], "description": "The type of reference" }, "url": { "type": "string", "description": "The URL of the reference" }, "label": { "type": "string", "description": "The display label for the reference" } }, "required": ["type", "url", "label"] } }, "supportedModels": { "$ref": "#/components/schemas/ProviderModelSupport" }, "passthrough": { "$ref": "#/components/schemas/ProviderPassthroughSupport" } }, "required": [ "code", "name", "status", "logo", "icon", "supportedModels", "passthrough" ] }, "ProviderPassthroughSupport": { "title": "ProviderPassthroughSupport", "description": "Provider-level passthrough request support.", "type": "object", "required": ["supported"], "properties": { "supported": { "type": "boolean", "description": "Whether Terminal supports authenticated passthrough requests for this provider." } } }, "SupportStatus": { "type": "string", "description": "Enum values:\n- `supported`: Terminal supports this resource\n- `not_supported_by_terminal`: Terminal does not support this resource\n- `not_supported_by_provider`: The provider does not support this resource", "enum": [ "supported", "not_supported_by_terminal", "not_supported_by_provider" ] }, "ModelSupportedOperations": { "title": "ModelSupportedOperations", "description": "Common structure for model support status containing the supported operations.", "type": "object", "required": ["supportedOperations"], "properties": { "supportedOperations": { "type": "object", "required": ["read"], "properties": { "read": { "$ref": "#/components/schemas/SupportStatus" } } } } }, "ProviderModelSupport": { "title": "ProviderModelSupport", "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "Vehicle": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "Driver": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "LatestVehicleLocation": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "VehicleLocation": { "allOf": [ { "$ref": "#/components/schemas/ModelSupportedOperations" }, { "type": "object", "required": ["sampleRate"], "properties": { "sampleRate": { "type": "string", "description": "How frequently is data captured by the vehicle", "example": "30 seconds" }, "availableHistory": { "type": "string", "example": "1 year", "description": "How much history is available to backfill. No history is available if undefined." } } } ] }, "VehicleStatLog": { "allOf": [ { "$ref": "#/components/schemas/ModelSupportedOperations" }, { "type": "object", "required": ["types"], "properties": { "types": { "type": "array", "description": "The types of vehicle stat logs that are supported by this provider.", "example": [ "odometer", "engine_state", "fuel_level", "engine_runtime" ], "items": { "$ref": "#/components/schemas/VehicleStatLogType" } } } } ] }, "Trailer": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "LatestTrailerLocation": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "Trip": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "Device": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "HOSLog": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "HOSDailyLog": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "HOSAvailableTime": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "IFTASummary": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "SafetyEvent": { "allOf": [ { "$ref": "#/components/schemas/ModelSupportedOperations" }, { "type": "object", "required": ["types"], "properties": { "types": { "type": "array", "description": "The types of safety events that are supported by this provider.", "example": [ "speeding", "harsh_brake", "harsh_acceleration", "harsh_turn", "crash" ], "items": { "$ref": "#/components/schemas/SafetyEventType" } } } } ] }, "CameraMedia": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "FaultCodeEvent": { "$ref": "#/components/schemas/ModelSupportedOperations" }, "VehicleUtilization": { "$ref": "#/components/schemas/ModelSupportedOperations" } }, "required": [ "Group", "Vehicle", "Driver", "VehicleLocation", "LatestVehicleLocation", "VehicleStatLog", "Trailer", "LatestTrailerLocation", "Trip", "Device", "HOSLog", "HOSDailyLog", "HOSAvailableTime", "IFTASummary", "SafetyEvent", "CameraMedia", "FaultCodeEvent", "VehicleUtilization" ] }, "EntityMetadata": { "title": "EntityMetadata", "type": "object", "description": "Internal metadata about the record.", "required": ["addedAt", "modifiedAt"], "properties": { "addedAt": { "$ref": "#/components/schemas/AddedAt" }, "modifiedAt": { "$ref": "#/components/schemas/ModifiedAt" } } }, "DeletableEntityMetadata": { "title": "DeletableEntityMetadata", "type": "object", "description": "Internal metadata about the record.", "required": ["addedAt", "modifiedAt"], "properties": { "addedAt": { "$ref": "#/components/schemas/AddedAt" }, "modifiedAt": { "$ref": "#/components/schemas/ModifiedAt" }, "deletedAt": { "$ref": "#/components/schemas/DeletedAt" } } }, "TimeSeriesMetadata": { "title": "TimeSeriesMetadata", "type": "object", "description": "Internal metadata about the time series.", "required": ["modifiedAt"], "properties": { "modifiedAt": { "$ref": "#/components/schemas/ModifiedAt" } } }, "ExpandableGroup": { "example": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/GroupId" }, { "$ref": "#/components/schemas/ExpandedGroup" } ] }, "ExpandableConnection": { "title": "ExpandableConnection", "example": "conn_01GV12VR4DJP70GD1ZBK0SDWFH", "oneOf": [ { "$ref": "#/components/schemas/ConnectionId" }, { "$ref": "#/components/schemas/ExpandedConnection" } ] }, "VehicleId": { "title": "VehicleId", "description": "Unique identifier for the vehicle in Terminal.", "type": "string", "format": "ulid", "pattern": "^vcl_[0-9A-HJKMNP-TV-Z]{26}$", "example": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "Vehicle": { "title": "Vehicle", "type": "object", "additionalProperties": false, "x-model-category": "entity", "properties": { "id": { "$ref": "#/components/schemas/VehicleId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "example": "active", "description": "The status in the providers system" }, "vin": { "title": "VIN", "type": "string", "example": "1HGCM82633A004352" }, "name": { "type": "string", "example": "Big Red" }, "make": { "type": "string", "example": "Peterbilt" }, "model": { "type": "string", "example": "Model 579" }, "year": { "type": "integer", "example": 2016 }, "groups": { "type": "array", "description": "The groups the vehicle belongs to.", "items": { "$ref": "#/components/schemas/ExpandableGroup" } }, "devices": { "type": "array", "description": "The devices installed in the vehicle.", "items": { "$ref": "#/components/schemas/ExpandableDevice" } }, "licensePlate": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "ABC-1234" } } }, "fuelType": { "enum": [ "gasoline", "diesel", "propane", "electric", "hybrid_gasoline", "hybrid_diesel", "biodiesel", "compressed_natural_gas", "liquefied_natural_gas", "ethanol", "hydrogen", "plug_in_hybrid" ], "example": "diesel" }, "fuelEfficiency": { "type": "number", "deprecated": true, "description": "This field will be removed in the future as is not commonly available from providers.", "example": 27.4 }, "fuelTankCapacity": { "description": "Maximum amount of fuel vehicle can hold in liters.", "title": "Volume In Liters", "type": "number", "example": 95.33 }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a vehicle in Terminal." }, "DriverId": { "title": "DriverId", "description": "Unique identifier for the driver in Terminal.", "type": "string", "format": "ulid", "pattern": "^drv_[0-9A-HJKMNP-TV-Z]{26}$", "example": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "Driver": { "title": "Driver", "type": "object", "additionalProperties": false, "x-model-category": "entity", "examples": [], "properties": { "id": { "$ref": "#/components/schemas/DriverId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "example": "active", "description": "The status in the providers system" }, "firstName": { "type": "string", "example": "Mike" }, "middleName": { "type": "string", "example": "Bryan" }, "lastName": { "type": "string", "example": "Miller" }, "email": { "type": "string", "format": "email", "example": "driver@example.com" }, "phone": { "title": "Phone", "type": "string", "pattern": "^\\+?\\d{10,14}$", "example": "+19058084567", "description": "Phone number formatted in [E.164](https://www.twilio.com/docs/glossary/what-e164) formatting" }, "username": { "type": "string", "description": "The driver's username for login purposes", "example": "driver123" }, "license": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "123-456-789-0" } } }, "groups": { "type": "array", "description": "The groups the driver belongs to.", "items": { "$ref": "#/components/schemas/ExpandableGroup" } }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a driver in Terminal." }, "GroupId": { "title": "GroupId", "type": "string", "format": "ulid", "example": "group_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "Group": { "title": "Group", "type": "object", "x-model-category": "entity", "properties": { "id": { "$ref": "#/components/schemas/GroupId" }, "sourceId": { "type": "string", "example": "12345" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "name": { "type": "string", "example": "California Division" }, "description": { "type": "string", "example": "Resources part of the California division" }, "parent": { "$ref": "#/components/schemas/ExpandableGroup", "description": "The parent of this group." }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "metadata"], "x-description": "A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider." }, "ExpandableDriver": { "example": "drv_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/DriverId" }, { "$ref": "#/components/schemas/ExpandedDriver" } ] }, "DeviceId": { "title": "DeviceId", "type": "string", "format": "ulid", "example": "dvc_61D9ZWFGHVJ858NBF2Q7DV9MNC" }, "DeviceType": { "title": "Device Type", "type": "string", "enum": ["tracker", "camera", "phone"], "example": "tracker" }, "Device": { "title": "Device", "type": "object", "x-model-category": "entity", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/DeviceId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "type": { "description": "The type of device", "$ref": "#/components/schemas/DeviceType" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle that the device is associated with." }, "description": { "type": "string", "description": "The description or model of the device", "example": "CM31" }, "serialNumber": { "type": "string", "description": "The serial number of the device", "example": "1234567890" }, "lastConnectedAt": { "description": "The time the device was last connected", "$ref": "#/components/schemas/ISODateTime" }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "type", "metadata"], "x-description": "Type of device installed in a vehicle." }, "ExpandableDevice": { "example": "dvc_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/DeviceId" }, { "$ref": "#/components/schemas/ExpandedDevice" } ] }, "ExpandableVehicle": { "example": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/VehicleId" }, { "$ref": "#/components/schemas/ExpandedVehicle" } ] }, "TrailerId": { "title": "TrailerId", "type": "string", "format": "ulid", "example": "trl_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "Trailer": { "title": "Trailer", "type": "object", "additionalProperties": false, "x-model-category": "entity", "properties": { "id": { "$ref": "#/components/schemas/TrailerId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "description": "The status in the providers system" }, "name": { "type": "string", "example": "Trailer #02323" }, "vin": { "$ref": "#/components/schemas/VIN" }, "serialNumber": { "type": "string", "example": "004352" }, "make": { "type": "string", "example": "Great Dane Trailers" }, "model": { "type": "string", "example": "Champion CP Plate Van with 24 Posts" }, "year": { "type": "integer", "example": 2013 }, "groups": { "type": "array", "description": "The groups the trailer belongs to.", "items": { "$ref": "#/components/schemas/ExpandableGroup" } }, "licensePlate": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "ABC-1234" } } }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a trailer in Terminal." }, "ExpandableTrailer": { "example": "trl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/TrailerId" }, { "$ref": "#/components/schemas/ExpandedTrailer" } ] }, "VehicleLocationId": { "title": "VehicleLocationId", "description": "Unique identifier for the vehicle location in Terminal.", "type": "string", "format": "ulid", "example": "vcl_loc_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "CameraMediaFileReference": { "title": "Camera Media Reference", "type": "object", "properties": { "available": { "type": "boolean", "description": "Indicates whether the camera media file is available for retrieval.", "example": true }, "sourceId": { "type": "string", "description": "The identifier for the camera media file in the source system.", "example": "12345" } }, "required": ["available"] }, "CameraMediaReference": { "title": "Camera Media Reference", "type": "object", "properties": { "frontFacing": { "description": "The front facing camera media.", "$ref": "#/components/schemas/CameraMediaFileReference" }, "rearFacing": { "description": "The rear facing camera media.", "$ref": "#/components/schemas/CameraMediaFileReference" } } }, "CameraMediaFile": { "title": "Camera Media File", "type": "object", "properties": { "sourceId": { "description": "The identifier for the camera media file in the source system.", "example": "12345", "type": "string" }, "videoUrl": { "description": "A URL to download the video file.", "example": "https://example.com/video.mp4", "type": "string" }, "imageUrl": { "description": "A URL to download the image file.", "example": "https://example.com/image.jpg", "type": "string" } } }, "CameraMedia": { "title": "Camera Media", "type": "object", "x-model-category": "other", "properties": { "frontFacing": { "description": "The front facing camera media.", "$ref": "#/components/schemas/CameraMediaFile" }, "rearFacing": { "description": "The rear facing camera media.", "$ref": "#/components/schemas/CameraMediaFile" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "x-description": "Media from vehicle cameras associated with safety events." }, "BaseVehicleLocation": { "title": "Base Vehicle Location", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle that the location is tracking." }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver that was driving the vehicle at the time of this location." }, "locatedAt": { "$ref": "#/components/schemas/ISODateTime" }, "location": { "$ref": "#/components/schemas/Coordinates" }, "address": { "type": "object", "description": "Reverse geocoded address details for locations when available at the source.", "properties": { "formatted": { "type": "string", "example": "1.5 miles from Austin, TX" } } }, "heading": { "$ref": "#/components/schemas/HeadingInDegrees" }, "speed": { "$ref": "#/components/schemas/SpeedInKPH" } }, "required": ["provider", "vehicle", "locatedAt", "location"] }, "VehicleLocation": { "title": "Vehicle Location", "x-model-category": "time-series", "allOf": [ { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/VehicleLocationId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" } }, "required": ["id"] }, { "$ref": "#/components/schemas/BaseVehicleLocation" }, { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/TimeSeriesMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["metadata"] } ], "x-description": "A point-in-time record of a vehicle's location." }, "LatestVehicleLocation": { "title": "Latest Vehicle Location", "x-model-category": "real-time", "allOf": [ { "$ref": "#/components/schemas/BaseVehicleLocation" }, { "type": "object", "properties": { "odometer": { "$ref": "#/components/schemas/DistanceInKilometers" }, "fuel": { "$ref": "#/components/schemas/FuelTanksPercentage" }, "engineState": { "$ref": "#/components/schemas/EngineState", "description": "The current state of the vehicle's engine" }, "engineRuntime": { "$ref": "#/components/schemas/DurationInMS", "description": "Total engine runtime duration" }, "raw": { "$ref": "#/components/schemas/RawDataList" } } } ], "x-description": "The latest record of a vehicle's location according to the provider." }, "VehicleStatLogId": { "title": "VehicleStatLogId", "type": "string", "format": "ulid", "example": "vcl_st_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "EngineState": { "type": "string", "enum": ["on", "off", "idle"] }, "VehicleStatLog": { "x-model-category": "time-series", "title": "Vehicle Stat Log", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/VehicleStatLogId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "type": { "type": "string" }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle this event is about." }, "metadata": { "$ref": "#/components/schemas/TimeSeriesMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "provider", "type", "timestamp", "vehicle", "metadata" ], "discriminator": { "propertyName": "type" }, "oneOf": [ { "title": "Engine State Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_state" }, "state": { "$ref": "#/components/schemas/EngineState" } }, "required": ["type", "state"] }, { "title": "Odometer Log", "type": "object", "properties": { "type": { "type": "string", "const": "odometer" }, "odometer": { "$ref": "#/components/schemas/DistanceInKilometers" } }, "required": ["type", "odometer"] }, { "title": "Total Fuel Consumption Log", "type": "object", "properties": { "type": { "type": "string", "const": "total_fuel_consumption" }, "fuelConsumed": { "$ref": "#/components/schemas/VolumeInLiters" } }, "required": ["type", "fuelConsumed"] }, { "title": "Fuel Level Log", "type": "object", "properties": { "type": { "type": "string", "const": "fuel_level" }, "fuelPercentage": { "$ref": "#/components/schemas/FuelPercentage" } }, "required": ["type", "fuelPercentage"] }, { "title": "Engine Runtime Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_runtime" }, "duration": { "$ref": "#/components/schemas/DurationInMS" } }, "required": ["type", "duration"] }, { "title": "Engine Oil Percentage Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_oil_percentage" }, "percentage": { "$ref": "#/components/schemas/Percentage" } }, "required": ["type", "percentage"] }, { "title": "Engine Oil Pressure Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_oil_pressure" }, "pressure": { "$ref": "#/components/schemas/PressureInPSI" } }, "required": ["type", "pressure"] }, { "title": "Engine Oil Temperature Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_oil_temperature" }, "temperature": { "$ref": "#/components/schemas/TemperatureInCelsius" } }, "required": ["type", "temperature"] }, { "title": "Engine Coolant Temperature Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_coolant_temperature" }, "temperature": { "$ref": "#/components/schemas/TemperatureInCelsius" } }, "required": ["type", "temperature"] }, { "title": "Coolant Percentage Log", "type": "object", "properties": { "type": { "type": "string", "const": "coolant_percentage" }, "percentage": { "$ref": "#/components/schemas/Percentage" } }, "required": ["type", "percentage"] }, { "title": "Engine RPM Log", "type": "object", "properties": { "type": { "type": "string", "const": "engine_rpm" }, "rpm": { "$ref": "#/components/schemas/RPM" } }, "required": ["type", "rpm"] }, { "title": "Battery Voltage Log", "type": "object", "properties": { "type": { "type": "string", "const": "battery_voltage" }, "voltage": { "$ref": "#/components/schemas/VoltageInVolts" } }, "required": ["type", "voltage"] } ], "example": [ { "id": "vcl_st_01D8ZQFGHVJ858NBF2Q7DV9MNC", "sourceId": "123456789", "provider": "geotab", "type": "engine_state", "timestamp": "2021-01-06T03:24:53.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "state": "on", "metadata": { "modifiedAt": "2021-01-06T03:24:53.000Z" }, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M2D", "sourceId": "987654321", "provider": "geotab", "type": "odometer", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "odometer": 230843, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3E", "sourceId": "987654322", "provider": "geotab", "type": "engine_runtime", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "duration": 1234.5, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3F", "sourceId": "987654323", "provider": "geotab", "type": "engine_oil_percentage", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "percentage": 85, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3G", "sourceId": "987654324", "provider": "geotab", "type": "engine_oil_pressure", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "pressure": 45.2, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3H", "sourceId": "987654325", "provider": "geotab", "type": "engine_oil_temperature", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "temperature": 95, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3I", "sourceId": "987654326", "provider": "geotab", "type": "engine_coolant_temperature", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "temperature": 90, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3J", "sourceId": "987654327", "provider": "geotab", "type": "coolant_percentage", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "percentage": 75, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3K", "sourceId": "987654328", "provider": "geotab", "type": "engine_rpm", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "rpm": 2500, "raw": [] }, { "id": "vcl_st_01D8ZQFGHVJ8584BF2Q7D29M3L", "sourceId": "987654329", "provider": "geotab", "type": "battery_voltage", "timestamp": "2021-01-06T04:34:52.000Z", "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC", "voltage": 12.5, "raw": [] } ], "x-description": "A point-in-time record of stats and logs for a specific vehicle." }, "SafetyEventType": { "title": "SafetyEventType", "type": "string", "enum": [ "harsh_brake", "harsh_acceleration", "harsh_turn", "speeding", "crash", "near_crash", "tailgating", "cell_phone", "distracted", "drowsiness", "smoking", "seat_belt_violation", "stop_sign_violation", "red_light_violation", "unsafe_lane_change", "camera_obstruction", "eating_and_drinking", "rolling_stop", "unsafe_parking" ] }, "VehicleStatLogType": { "title": "VehicleStatLogType", "type": "string", "enum": [ "engine_state", "odometer", "total_fuel_consumption", "fuel_level", "engine_runtime", "engine_oil_percentage", "engine_oil_pressure", "engine_oil_temperature", "engine_coolant_temperature", "coolant_percentage", "engine_rpm", "battery_voltage" ] }, "SafetyEventId": { "title": "SafetyEventId", "type": "string", "format": "ulid", "pattern": "^sft_evt_[0-9A-HJKMNP-TV-Z]{26}$", "example": "sft_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "SafetyEvent": { "type": "object", "title": "Safety Event", "additionalProperties": false, "x-model-category": "time-series", "properties": { "id": { "$ref": "#/components/schemas/SafetyEventId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "type": { "$ref": "#/components/schemas/SafetyEventType" }, "sourceType": { "type": "string", "example": "HARD_CORE_BRAKING_MESSAGE", "description": "The original event type as defined by the telematics provider's system" }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver that was driving during the event." }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle that was involved in the event." }, "startedAt": { "$ref": "#/components/schemas/ISODateTime" }, "startLocation": { "$ref": "#/components/schemas/Coordinates" }, "endedAt": { "$ref": "#/components/schemas/ISODateTime" }, "endLocation": { "$ref": "#/components/schemas/Coordinates" }, "stats": { "type": "object", "properties": { "maximumSpeed": { "$ref": "#/components/schemas/SpeedInKPH", "description": "Maximum speed of the vehicle in KPH, rounded to 2 decimal places." }, "averageSpeed": { "$ref": "#/components/schemas/SpeedInKPH", "description": "Average speed of the vehicle in KPH, rounded to 2 decimal places." }, "roadSpeedLimit": { "$ref": "#/components/schemas/SpeedInKPH", "description": "Speed limit of the road in KPH, rounded to 2 decimal places." }, "gForceForwardBackward": { "$ref": "#/components/schemas/GForce", "description": "The acceleration/breaking force as a factor of gravity (g)." }, "gForceSideToSide": { "$ref": "#/components/schemas/GForce", "description": "The cornering (lateral) acceleration as a factor of gravity (g)." }, "heading": { "$ref": "#/components/schemas/HeadingInDegrees", "description": "Heading of the vehicle (in degrees)" } } }, "cameraMedia": { "$ref": "#/components/schemas/CameraMediaReference" }, "metadata": { "$ref": "#/components/schemas/DeletableEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "sourceId", "provider", "type", "vehicle", "startedAt", "metadata" ], "x-description": "A normalized record of a safety-related incident that occurred during a vehicle's operation. These events are detected and recorded by the telematics provider's system." }, "TripId": { "title": "TripId", "type": "string", "format": "ulid", "example": "trp_01D9ZQFGHVJ858NBF2Q7DV9MNH" }, "Trip": { "title": "Trip", "type": "object", "x-model-category": "time-series", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/TripId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver that was driving during the trip." }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle that was involved in the trip." }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "startedAt": { "description": "The time the trip started", "$ref": "#/components/schemas/ISODateTime" }, "endedAt": { "description": "The time the trip ended", "$ref": "#/components/schemas/ISODateTime" }, "startLocation": { "$ref": "#/components/schemas/Coordinates" }, "endLocation": { "$ref": "#/components/schemas/Coordinates" }, "distance": { "$ref": "#/components/schemas/DistanceInKilometers" }, "duration": { "$ref": "#/components/schemas/DurationInMS", "minimum": 0 }, "metadata": { "$ref": "#/components/schemas/DeletableEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "provider", "sourceId", "vehicle", "startedAt", "endedAt", "duration", "metadata" ], "x-description": "Trips define a period of time where a vehicle is in motion. Trips are based on the provider's definition." }, "VehicleUtilizationDayId": { "title": "VehicleUtilizationDayId", "type": "string", "format": "ulid", "example": "vcl_day_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "VehicleUtilizationDay": { "title": "Vehicle Utilization Day", "type": "object", "x-model-category": "time-series", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/VehicleUtilizationDayId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle this utilization data is for." }, "date": { "type": "string", "format": "date", "example": "2021-01-06", "description": "The date this utilization data represents." }, "fuelConsumed": { "$ref": "#/components/schemas/VolumeInLiters", "description": "Fuel consumed during this date in liters." }, "distance": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance traveled during this date in kilometers." }, "durations": { "type": "object", "additionalProperties": false, "properties": { "driving": { "$ref": "#/components/schemas/DurationInMS", "description": "Time spent driving during this date in milliseconds." }, "idling": { "$ref": "#/components/schemas/DurationInMS", "description": "Time spent idling during this date in milliseconds." } } }, "metadata": { "$ref": "#/components/schemas/EntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "provider", "vehicle", "date", "distance", "metadata" ], "x-description": "Daily vehicle usage metrics for a specific vehicle and date." }, "VehicleUtilization": { "title": "Vehicle Utilization", "type": "object", "x-model-category": "time-series", "additionalProperties": false, "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle this utilization data is for." }, "startAt": { "type": "string", "format": "date-time", "description": "The start date of the utilization data." }, "endAt": { "type": "string", "format": "date-time", "description": "The end date of the utilization data." }, "fuelConsumed": { "$ref": "#/components/schemas/VolumeInLiters", "description": "Fuel consumed during this date in liters." }, "distance": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance traveled during this date in kilometers." }, "durations": { "type": "object", "properties": { "driving": { "$ref": "#/components/schemas/DurationInMS", "description": "Time spent driving during this date in milliseconds." }, "idling": { "$ref": "#/components/schemas/DurationInMS", "description": "Time spent idling during this date in milliseconds." } } }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["provider", "vehicle", "startAt", "endAt", "distance"], "x-description": "Vehicle usage metrics for a specific vehicle and date range." }, "FaultCodeEventId": { "title": "FaultCodeEventId", "type": "string", "format": "ulid", "example": "fc_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "FaultCodeEvent": { "title": "Fault Code Event", "x-model-category": "time-series", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/FaultCodeEventId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle associated with the fault." }, "protocol": { "$ref": "#/components/schemas/FaultCodeProtocol" }, "status": { "type": "string", "enum": ["open", "pending", "closed"], "description": "The status of the fault code at the time of the event. Some providers do not report closed statuses." }, "code": { "type": "string", "example": "P0087", "description": "The fault code identifier. For OBD-II systems: alphanumeric DTC codes (P0087, U0046, C0123, B1234). For J1939 systems: SPN-FMI format (SPN3031-FMI9) or derived codes from SPN/FMI combinations." }, "description": { "type": "string", "example": "Fuel Rail/System Pressure - Too Low Bank 1", "description": "Human-readable description of the fault" }, "observedAt": { "$ref": "#/components/schemas/ISODateTime", "description": "The time the fault code was observed" }, "milStatus": { "type": "string", "enum": ["on", "off"], "description": "The Malfunction Indicator Lamp (MIL) status of the vehicle at the time the fault code was observed" }, "obdii": { "type": "object", "description": "OBD-II Diagnostic Trouble Code information for light/medium duty vehicles. Contains standardized alphanumeric codes like P0087, U0046, C0123, B1234.", "properties": { "code": { "type": "string", "example": "P0087", "description": "Alphanumeric DTC code (e.g., P0087, U0046)" }, "description": { "type": "string", "example": "Fuel Rail/System Pressure - Too Low Bank 1", "description": "Human-readable description of the DTC" } }, "required": ["code"] }, "j1939": { "type": "object", "description": "J1939 fault code information for heavy-duty vehicles. FMI (Failure Mode Identifier) indicates the specific nature of the fault (0-31 numeric codes).", "properties": { "fmi": { "type": "integer", "example": 9, "description": "Failure Mode Identifier (FMI) - numeric code (0-31) indicating the specific nature of the fault" }, "fmiDescription": { "type": "string", "example": "Voltage Below Normal", "description": "Human-readable description of the FMI failure mode" }, "spn": { "type": "integer", "example": 3031, "description": "Suspect Parameter Number (SPN) - identifies the specific parameter/system affected" }, "spnDescription": { "type": "string", "example": "System Diagnostic Code #1", "description": "Human-readable description of the SPN parameter/system" }, "occurrenceCount": { "type": "integer", "example": 15, "description": "The occurrence count reported by the provider at the time the fault code was observed" }, "sourceAddress": { "type": "integer", "example": 256, "description": "The source address of the fault code" } }, "required": ["spn"] }, "metadata": { "$ref": "#/components/schemas/EntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "discriminator": { "propertyName": "protocol" }, "oneOf": [ { "title": "FaultCodeEventObdii", "properties": { "protocol": { "const": "obdii" } }, "required": ["protocol", "obdii"] }, { "title": "FaultCodeEventJ1939", "properties": { "protocol": { "const": "j1939" } }, "required": ["protocol", "j1939"] } ], "required": [ "id", "provider", "vehicle", "code", "protocol", "observedAt", "status", "metadata" ], "x-description": "A fault code observed at a specific time" }, "HOSStatus": { "type": "string", "enum": [ "off_duty", "sleeper_bed", "driving", "on_duty", "yard_move", "personal_conveyance", "waiting_time" ] }, "HOSLogId": { "title": "HOSLogId", "type": "string", "format": "ulid", "example": "hos_log_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "HOSLog": { "title": "HOS Log", "x-model-category": "time-series", "additionalProperties": false, "type": "object", "properties": { "id": { "$ref": "#/components/schemas/HOSLogId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "$ref": "#/components/schemas/HOSStatus" }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver this log belongs to." }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle the driver was driving when the log was recorded." }, "codrivers": { "type": "array", "description": "Additional drivers that were included in the HOS log.", "items": { "$ref": "#/components/schemas/ExpandableDriver" } }, "startedAt": { "$ref": "#/components/schemas/ISODateTime" }, "endedAt": { "$ref": "#/components/schemas/ISODateTime" }, "location": { "$ref": "#/components/schemas/Coordinates", "description": "Where the log was recorded" }, "remarks": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "$ref": "#/components/schemas/SourceId" }, "submittedAt": { "$ref": "#/components/schemas/ISODateTime" }, "notes": { "type": "string", "description": "Additional comments" } }, "required": ["notes"] } }, "metadata": { "$ref": "#/components/schemas/DeletableEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "sourceId", "provider", "status", "driver", "startedAt", "remarks", "metadata" ], "x-description": "Records a change in duty status by a driver." }, "HOSDailyLogId": { "title": "HOSDailyLogId", "type": "string", "format": "ulid", "example": "hos_day_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "HOSDailyLog": { "title": "HOS Daily Log", "type": "object", "x-model-category": "time-series", "properties": { "id": { "$ref": "#/components/schemas/HOSDailyLogId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver this log belongs to." }, "vehicles": { "type": "array", "description": "Vehicles associated with this daily HOS log.", "items": { "$ref": "#/components/schemas/ExpandableVehicle" } }, "date": { "type": "string", "format": "date", "example": "2021-01-06" }, "distances": { "type": "object", "description": "Breakdown of different distance measurements for the day when available in the source system", "properties": { "total": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Total distance driven during this day in kilometers" }, "driving": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance driven during driving" }, "personalConveyance": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance driven during personal conveyance" }, "yardMove": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance driven during yard moves" } } }, "statusDurations": { "type": "object", "properties": { "onDuty": { "$ref": "#/components/schemas/DurationInMS", "example": 11252299 }, "offDuty": { "$ref": "#/components/schemas/DurationInMS", "example": 48478999 }, "driving": { "$ref": "#/components/schemas/DurationInMS", "example": 26668701 }, "waiting": { "$ref": "#/components/schemas/DurationInMS", "example": 232322 }, "sleeperBed": { "$ref": "#/components/schemas/DurationInMS", "example": 2300000 }, "personalConveyance": { "$ref": "#/components/schemas/DurationInMS", "example": 500000 }, "yardMove": { "$ref": "#/components/schemas/DurationInMS", "example": 62000 } } }, "metadata": { "$ref": "#/components/schemas/EntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "sourceId", "provider", "driver", "date", "statusDurations", "metadata" ], "x-description": "Record of daily hours of service." }, "HOSAvailableTime": { "title": "HOS Available Time", "type": "object", "x-model-category": "real-time", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "driver": { "$ref": "#/components/schemas/ExpandableDriver", "description": "The driver this available time is for." }, "currentStatus": { "$ref": "#/components/schemas/HOSStatus", "example": "driving", "description": "The current status of the driver" }, "currentStatusStartedAt": { "$ref": "#/components/schemas/ISODateTime", "description": "The time the driver's current HOS status started" }, "availableTime": { "type": "object", "example": { "cycle": 252000000, "shift": 50400000, "drive": 39600000, "break": 28800000 }, "description": "Available time remaning in milliseconds", "properties": { "cycle": { "$ref": "#/components/schemas/DurationInMS", "example": 252000000, "description": "The total remaining time for the driver's current cycle (ex: 70 hours). Value is in milliseconds." }, "shift": { "$ref": "#/components/schemas/DurationInMS", "example": 50400000, "description": "The total remaining time for the driver's current shift (ex: 14 hours). Value is in milliseconds." }, "drive": { "$ref": "#/components/schemas/DurationInMS", "example": 39600000, "description": "The total remaining drive time for the driver's current shift (ex: 11 hours). Value is in milliseconds." }, "break": { "$ref": "#/components/schemas/DurationInMS", "example": 28800000, "description": "The amount of time before the next break is required (ex: 8 hours). Value is in milliseconds." } } }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["provider", "driver", "availableTime"], "x-description": "The available time left on the clock for a specific driver." }, "IFTAReportId": { "title": "IFTAReportId", "type": "string", "format": "ulid", "example": "ifta_rpt_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "IFTAVehicleMonth": { "title": "IFTA Vehicle Month", "type": "object", "x-model-category": "time-series", "properties": { "id": { "$ref": "#/components/schemas/IFTAReportId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle this IFTA report is for." }, "month": { "$ref": "#/components/schemas/ISOMonth", "description": "The calendar month of the report, as defined by the provider's IFTA report." }, "jurisdiction": { "description": "The IFTA jurisdiction: a US state, US territory, DC, or Canadian province or territory. `null` when the provider reports a jurisdiction outside this list, such as Mexico, or reports no recognizable jurisdiction.", "example": "TN", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/State" } ] }, "distance": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Distance driven in this jurisdiction during this month." }, "metadata": { "$ref": "#/components/schemas/EntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": [ "id", "provider", "vehicle", "month", "jurisdiction", "distance", "metadata" ], "x-description": "Distance driven by a vehicle in one jurisdiction during one calendar month. In the API, this is summarized by the [IFTA Summary](/models/iftasummary) model." }, "IFTASummary": { "title": "IFTA Summary", "x-model-category": "time-series", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "vehicle": { "$ref": "#/components/schemas/ExpandableVehicle", "description": "The vehicle this IFTA summary is for. Only returned when `groupBy` includes `vehicle`." }, "jurisdiction": { "description": "The IFTA jurisdiction: a US state, US territory, DC, or Canadian province or territory. `null` when the provider reports a jurisdiction outside this list, such as Mexico, or reports no recognizable jurisdiction. Only returned when `groupBy` includes `jurisdiction`.", "example": "TN", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/State" } ] }, "distance": { "$ref": "#/components/schemas/DistanceInKilometers", "description": "Total distance driven for this group." }, "month": { "$ref": "#/components/schemas/ISOMonth", "description": "The calendar month of the report, as defined by the provider's IFTA report. Only returned when `groupBy` includes `month`." }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["provider", "distance"], "x-description": "Distance driven, totaled by vehicle, jurisdiction, and month according to the `groupBy` you request. Covers full calendar months only." }, "LatestTrailerLocation": { "title": "Latest Trailer Location", "type": "object", "x-model-category": "real-time", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "trailer": { "$ref": "#/components/schemas/ExpandableTrailer", "description": "The trailer this location belongs to." }, "locatedAt": { "$ref": "#/components/schemas/ISODateTime" }, "location": { "$ref": "#/components/schemas/Coordinates" }, "address": { "type": "object", "description": "Reverse geocoded address details for locations when available at the source.", "properties": { "formatted": { "type": "string", "example": "1.5 miles from Austin, TX" } } }, "heading": { "$ref": "#/components/schemas/HeadingInDegrees" }, "speed": { "$ref": "#/components/schemas/SpeedInKPH" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["provider", "trailer", "locatedAt", "location"], "x-description": "The latest record of a trailer's location according to the provider." }, "Phone": { "title": "Phone", "type": "string", "pattern": "^\\+?\\d{10,14}$", "example": "+19058084567", "description": "Phone number formatted in [E.164](https://www.twilio.com/docs/glossary/what-e164) formatting" }, "State": { "title": "State", "type": "string", "enum": [ "AL", "AK", "AS", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MP", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "VI", "AB", "BC", "MB", "NB", "NL", "NS", "ON", "PE", "QC", "SK", "NT", "NU", "UM", "YT", "DC" ], "example": "TN", "description": "US State or Canadian Province" }, "ISOMonth": { "title": "ISOMonth", "type": "string", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])$", "example": "2021-01", "description": "[ISO 8601](https://www.w3.org/TR/NOTE-datetime) month" }, "Coordinates": { "title": "Coordinates", "type": "object", "properties": { "longitude": { "type": "number", "example": -122.4194155 }, "latitude": { "type": "number", "example": 37.7749295 } }, "required": ["longitude", "latitude"] }, "Connection": { "title": "Connection", "x-model-category": "platform", "oneOf": [ { "$ref": "#/components/schemas/FullConnection" }, { "$ref": "#/components/schemas/DeletedConnection" } ], "x-description": "The connection your application has with your customer's TSP." }, "FullConnection": { "title": "Full Connection", "description": "The connection your application has with your customer's TSP.", "allOf": [ { "title": "Connection Base", "type": "object", "description": "Fields shared by all connection records.", "properties": { "id": { "$ref": "#/components/schemas/ConnectionId" }, "company": { "type": "object", "properties": { "name": { "type": "string", "example": "Frank's Trucking", "description": "Optional name of the connection." }, "dotNumbers": { "type": "array", "description": "Optional DOT numbers associated with this connection.", "items": { "type": "string", "example": "1234567" } } } }, "account": { "type": "object", "properties": { "name": { "type": "string", "example": "Frank's Trucking", "description": "The name of the account according to the provider." }, "dotNumbers": { "type": "array", "description": "DOT numbers associated with the account according to the provider.", "items": { "type": "string", "example": "1234567" } }, "user": { "type": "object", "description": "The user of the provider account that created the connection.", "properties": { "sourceId": { "description": "The ID of the user in the provider's system.", "example": "1234567", "type": "string" }, "firstName": { "example": "John", "type": "string" }, "lastName": { "example": "Doe", "type": "string" }, "email": { "example": "john.doe@example.com", "type": "string" } } } } }, "provider": { "type": "object", "required": ["code", "name"], "properties": { "code": { "$ref": "#/components/schemas/ProviderCode" }, "name": { "type": "string", "example": "Geotab", "description": "The name of the Telematics Service Provider." } } }, "externalId": { "type": "string", "example": "1234", "description": "An optional ID from your system that can be used to reference connections." }, "sourceId": { "$ref": "#/components/schemas/SourceId", "description": "The ID used in the source system to represent the account this connection has or had access to.\n\nThis may be an `organizationId` or `accountId`.\n\nNote: not all systems expose this information, in which case it may be undefined." }, "syncMode": { "$ref": "#/components/schemas/SyncMode" }, "token": { "type": "string", "example": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4", "pattern": "^con_tkn_\\S+$", "description": "This token is used when interacting with a connections' data." }, "tags": { "type": "array", "description": "An optional list of tags from your system that can be used to reference connections.", "items": { "type": "string", "example": "Tag Name" } }, "createdAt": { "$ref": "#/components/schemas/ISODateTime" }, "updatedAt": { "$ref": "#/components/schemas/ISODateTime" } }, "required": [ "id", "company", "account", "provider", "syncMode", "token", "createdAt", "updatedAt" ] }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "connected", "disconnected", "archived", "pending_deletion" ], "description": "The current status of the connection." }, "options": { "$ref": "#/components/schemas/ProviderOptions" }, "filters": { "$ref": "#/components/schemas/ConnectionFilters" }, "linkUrl": { "type": "string", "format": "uri", "example": "https://link.withterminal.com/connection/{CONNECTION_ID}?key={PUBLISHABLE_KEY}", "description": "The URL to send your user to in order to have them re-authenticate the connection." } }, "required": ["status", "options", "linkUrl"] } ] }, "DeletedConnection": { "title": "Deleted Connection", "description": "A retained connection record after connection-scoped data has been deleted.", "allOf": [ { "$ref": "#/components/schemas/FullConnection/allOf/0" }, { "type": "object", "properties": { "status": { "type": "string", "enum": ["deleting", "deleted"] }, "deletedAt": { "$ref": "#/components/schemas/ISODateTime", "description": "When Terminal finished deleting connection-scoped data. Present once status is `deleted`." } }, "required": ["status"] } ] }, "SyncId": { "title": "SyncId", "type": "string", "format": "ulid", "pattern": "^sync_[0-9A-HJKMNP-TV-Z]{26}$", "example": "sync_01GV12VR4DJP70GD1ZBK0SDWFH" }, "Sync": { "title": "Sync", "type": "object", "x-model-category": "platform", "properties": { "id": { "$ref": "#/components/schemas/SyncId" }, "status": { "$ref": "#/components/schemas/SyncStatus" }, "failureReason": { "type": "string", "description": "If the sync failed, this will contain the reason", "example": "Reason for failure if sync status is 'failed'" }, "progress": { "$ref": "#/components/schemas/Percentage", "description": "Current sync progress as a percentage between 0 and 100." }, "issues": { "type": "array", "description": "Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing `issues` to the `expand` parameter.", "items": { "$ref": "#/components/schemas/ExpandableIssue" } }, "startFrom": { "$ref": "#/components/schemas/ISODateTime", "description": "The earliest records to sync for those based on time (ex: historical locations and stats)" }, "requestedAt": { "$ref": "#/components/schemas/ISODateTime" }, "completedAt": { "$ref": "#/components/schemas/ISODateTime" }, "attempts": { "type": "number", "example": 1 }, "providerRequests": { "type": "array", "description": "Provider requests attached to this sync. When non-empty, the sync is waiting on an out-of-band step on the provider's side (e.g. the provider manually delivering historical files, or credentials being provisioned) and may legitimately stay in progress for an extended period.", "example": ["historical_files"], "items": { "$ref": "#/components/schemas/SyncProviderRequestType" } } }, "required": ["id", "status", "requestedAt"], "x-description": "An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion." }, "SyncStatus": { "title": "SyncStatus", "type": "string", "description": "The status of the sync", "example": "completed", "enum": ["requested", "in_progress", "completed", "failed"] }, "ErrorPathDetail": { "title": "ErrorPathDetail", "type": "object", "properties": { "message": { "type": "string", "example": "'vehicleId' property must be a valid ulid" }, "path": { "type": "string", "example": "{requestQuery}.vehicleId" }, "suggestion": { "type": "string", "example": "Please ensure you submit a valid 'vehicleId' property" }, "context": { "type": "object" } }, "required": ["message", "path"] }, "TemperatureInCelsius": { "title": "Temperature In Celsius", "type": "number", "description": "Temperature in Celsius rounded to 2 decimal places.", "example": 95.33 }, "PressureInPSI": { "title": "Pressure In PSI", "type": "number", "description": "Pressure in PSI (Pounds per Square Inch) rounded to 2 decimal places.", "example": 45.2 }, "Percentage": { "title": "Percentage", "type": "number", "description": "Percentage value between 0 and 100, rounded to 2 decimal places.", "example": 85, "minimum": 0, "maximum": 100 }, "PaginationCursor": { "title": "Pagination Cursor", "type": "string", "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "description": "Cursor used for pagination.", "format": "cursor", "pattern": "^[A-Za-z0-9+/=_-]+$" }, "RowCountGroupBy": { "title": "Row Count Group By", "type": "string", "enum": ["day", "vehicle", "day,vehicle", "vehicle,day"], "description": "Used to control the aggregation of row counts. Use 'day' for daily rows, 'vehicle' for per-vehicle totals over the range, or combine both keys for per-day, per-vehicle rows. Omit this field for totals over the full date range." }, "RowCountModel": { "title": "Row Count Model", "type": "string", "enum": [ "VehicleLocation", "VehicleStatLog", "Trip", "SafetyEvent", "HOSLog", "HOSDailyLog", "VehicleUtilizationDay", "FaultCodeEvent", "IFTAVehicleMonth" ], "description": "Common model name used for row count aggregation." }, "RowCountEntry": { "title": "Row Count Entry", "type": "object", "properties": { "model": { "$ref": "#/components/schemas/RowCountModel" }, "date": { "type": "string", "format": "date", "description": "UTC date for the aggregation window when groupBy=day." }, "count": { "type": "integer", "minimum": 0 }, "vehicle": { "$ref": "#/components/schemas/VehicleId" } }, "required": ["model", "count"] }, "UsageRow": { "title": "Usage Row", "type": "object", "description": "Billable usage for a connection and vehicle in an ISO month.", "properties": { "connection": { "$ref": "#/components/schemas/ConnectionId" }, "vehicle": { "$ref": "#/components/schemas/VehicleId" }, "backfillUnitCount": { "type": "integer", "minimum": 1 } }, "required": ["connection", "vehicle"] }, "UsageResponse": { "title": "Usage Response", "type": "object", "description": "Billable usage for an application in an ISO month.", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/UsageRow" } }, "next": { "type": "string", "format": "cursor", "pattern": "^[A-Za-z0-9+/=_-]+$" } }, "required": ["results"] }, "DurationInMS": { "title": "DurationInMS", "type": "integer", "example": 0, "description": "Duration in MS" }, "DurationInHours": { "title": "DurationInHours", "type": "number", "example": 0, "description": "Duration in hours" }, "SpeedInKPH": { "title": "Speed In KPH", "type": "number", "description": "Speed in KPH rounded to 2 decimal places.", "example": 95.33 }, "VolumeInLiters": { "title": "Volume In Liters", "type": "number", "description": "Volume in liters rounded to 2 decimal places.", "example": 95.33 }, "GForce": { "title": "G-Force", "type": "number", "description": "Acceleration as a factor of gravity (g)", "example": 1 }, "HeadingInDegrees": { "title": "Heading In Degrees", "type": "number", "description": "Heading in degrees", "example": 25 }, "VoltageInVolts": { "title": "Voltage In Volts", "type": "number", "description": "Voltage in volts rounded to 2 decimal places.", "example": 12.5 }, "RPM": { "title": "RPM", "type": "number", "description": "Engine RPM (Revolutions Per Minute) rounded to 2 decimal places.", "example": 2500 }, "DistanceInKilometers": { "title": "Distance In Kilometers", "type": "number", "format": "double", "description": "Distance in kilometers", "example": 100.25 }, "FuelTanksPercentage": { "title": "Fuel Tanks Percentage", "type": "object", "description": "Fuel percentage", "properties": { "primaryPercentage": { "$ref": "#/components/schemas/FuelPercentage", "description": "The percentage value of how much fuel is left in the primary tank." }, "secondaryPercentage": { "$ref": "#/components/schemas/FuelPercentage", "description": "The percentage value of how much fuel is left in the secondary tank." } }, "required": ["primaryPercentage"] }, "FuelPercentage": { "title": "Fuel Percentage", "type": "number", "example": 50, "minimum": 0, "maximum": 100, "description": "The percentage value of how much fuel is left in the tank." }, "PublicToken": { "title": "Public Token", "type": "string", "example": "pub_tkn_9jNzH26e5b9RgErDnRt8zfm5emDUUyyG", "description": "Token returned by the authentication flow. Public tokens are one time use and expire after they are exchanged for a long-lived connection token.", "pattern": "^pub_tkn_\\S+$" }, "ShortLinkId": { "title": "ShortLinkId", "description": "Unique identifier for a short link. Returned on create and required to delete the short link.", "type": "string", "format": "ulid", "pattern": "^slk_[0-9A-HJKMNP-TV-Z]{26}$", "example": "slk_01JB7K3N2QZP7TVR4FX8SDWFH9" }, "ShortLink": { "title": "ShortLink", "type": "object", "description": "A short URL for the Link onboarding flow. The associated parameters are stored at creation time and retrieved when your user visits the URL.", "properties": { "id": { "$ref": "#/components/schemas/ShortLinkId", "description": "Durable identifier for the short link resource. Store this value if you may need to delete the short link later; it is the only identifier accepted by the delete endpoint." }, "code": { "type": "string", "pattern": "^[a-hjkmnp-z2-9]{8}$", "example": "az9qtk2d", "description": "8-character code that is associated with the original Link parameters. Used in the shared URL; cannot be used to delete the short link." }, "url": { "type": "string", "format": "uri", "example": "https://term.new/az9qtk2d", "description": "Full short URL to share with your user." }, "expiresAt": { "$ref": "#/components/schemas/ISODateTime", "description": "Timestamp at which the short link will stop resolving. It is set to 1 year from creation date." } }, "required": ["id", "code", "url", "expiresAt"] }, "PassthroughInput": { "title": "Passthrough Input", "type": "object", "properties": { "method": { "type": "string", "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"], "description": "The method for the third-party request, such as GET or POST.", "example": "POST" }, "path": { "type": "string", "description": "A relative provider path such as `/reports`, or an absolute URL. Absolute URLs are accepted only when they target the connection's provider host.", "example": "/reports" }, "headers": { "type": "object", "description": "The headers to use for the request (Terminal will handle the connection's authorization headers)" }, "body": { "type": "string", "description": "The request body", "example": "{\"reportId\":\"1234\"}" } }, "required": ["method", "path"] }, "JSONValue": { "title": "JSON Value", "oneOf": [ { "type": "object" }, { "type": "array" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "PassthroughOutput": { "title": "Passthrough Output", "type": "object", "properties": { "method": { "type": "string", "description": "The HTTP method that was used when making the request.", "example": "POST" }, "path": { "type": "string", "description": "The path that was called with the passthrough request.", "example": "/reports", "default": "/reports" }, "statusCode": { "type": "integer", "example": 200, "description": "The resulting status code from the passthrough request." }, "headers": { "type": "object", "example": { "Content-Type": "application/json" }, "description": "Any returned headers from the passthrough request." }, "response": { "$ref": "#/components/schemas/JSONValue", "example": { "reportId": "1234" }, "description": "The response body from the passthrough request" } }, "required": ["method", "path", "statusCode", "headers", "response"] }, "EventId": { "title": "EventId", "type": "string", "format": "ulid", "example": "evt_01GV12VR4DJP70GD1ZBK0SDWFH" }, "ConnectionCreated": { "title": "connection.created", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.created"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection is succesfully created with a provider account." }, "ConnectionDisconnected": { "title": "connection.disconnected", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.disconnected"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection is disconnected. This typically happens if credentials are deemed invalid and the user must re-authenticate." }, "ConnectionReconnected": { "title": "connection.reconnected", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.reconnected"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection is succesfully reconnected. This should happen when a customer re-authenticates after being disconnected." }, "ConnectionCompleted": { "title": "connection.completed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.completed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "metadata"], "properties": { "metadata": { "type": "object", "description": "Data passed during authentication, excluding existing connection details.", "properties": { "externalId": { "type": "string", "example": "1234" }, "tags": { "type": "array", "items": { "type": "string", "example": "Tag Name" } } } }, "connection": { "description": "The latest authenticated connection details, including merged information.", "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "This event is emitted when a user successfully completes the authentication process.\n\nThis can occur either by creating a new connection or by merging with an existing connection to avoid duplicates. Subscribing to this event allows you to receive details of any successful authentication along with the resulting connection information." }, "ConnectionUpdated": { "title": "connection.updated", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.updated"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection's details are updated." }, "ConnectionPendingDeletion": { "title": "connection.pending_deletion", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.pending_deletion"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/Connection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection has been marked for deletion." }, "ConnectionDeleted": { "title": "connection.deleted", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.deleted"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection"], "properties": { "connection": { "$ref": "#/components/schemas/DeletedConnection" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection's data has been deleted." }, "BasicConnection": { "title": "Basic Connection", "type": "object", "description": "Basic connection details to be able to reference connections from webhook events", "properties": { "id": { "$ref": "#/components/schemas/ConnectionId" }, "provider": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/ProviderCode" }, "name": { "type": "string", "example": "Geotab" } }, "required": ["code", "name"] }, "externalId": { "type": "string", "example": "123456789" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": ["id", "provider"] }, "SyncRequested": { "title": "sync.requested", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["sync.requested"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "sync"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "sync": { "$ref": "#/components/schemas/Sync" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection sync has been requested and is queued to run." }, "SyncStarted": { "title": "sync.started", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["sync.started"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "sync"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "sync": { "$ref": "#/components/schemas/Sync" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection sync has started running." }, "SyncCompleted": { "title": "sync.completed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["sync.completed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "sync"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "sync": { "$ref": "#/components/schemas/Sync" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection sync completes successfully. For S3/data delivery destinations, use delivery.completed to know when files have finished delivering." }, "SyncFailed": { "title": "sync.failed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["sync.failed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "sync"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "sync": { "$ref": "#/components/schemas/Sync" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection sync has failed to complete successfully." }, "ConnectionFirstSyncCompleted": { "title": "connection.first_sync_completed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["connection.first_sync_completed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "sync"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "sync": { "$ref": "#/components/schemas/Sync" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a connection's first successful sync completes. For S3/data delivery destinations, use delivery.completed to know when files have finished delivering." }, "BasicDestination": { "title": "Basic Destination", "type": "object", "description": "Basic destination details to be able to reference destinations from webhook events", "properties": { "id": { "type": "string", "example": "dst_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "type": { "type": "string", "example": "s3" } }, "required": ["id", "type"] }, "DeliveryRequested": { "title": "delivery.requested", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["delivery.requested"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["destination", "delivery"], "properties": { "destination": { "$ref": "#/components/schemas/BasicDestination" }, "delivery": { "type": "object", "required": ["id", "status", "requestedAt"], "properties": { "id": { "type": "string" }, "trigger": { "type": "string", "enum": ["manual", "schedule", "backfill"], "description": "What triggered this delivery." }, "status": { "type": "string", "enum": ["requested"] }, "connectionIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string", "format": "date-time" } } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a delivery is requested." }, "DeliveryStarted": { "title": "delivery.started", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["delivery.started"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["destination", "delivery"], "properties": { "destination": { "$ref": "#/components/schemas/BasicDestination" }, "delivery": { "type": "object", "required": ["id", "status", "requestedAt", "startedAt"], "properties": { "id": { "type": "string" }, "trigger": { "type": "string", "enum": ["manual", "schedule", "backfill"], "description": "What triggered this delivery." }, "status": { "type": "string", "enum": ["in_progress"] }, "connectionIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time" } } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a delivery starts processing." }, "DeliveryFailed": { "title": "delivery.failed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["delivery.failed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["destination", "delivery"], "properties": { "destination": { "$ref": "#/components/schemas/BasicDestination" }, "delivery": { "type": "object", "required": ["id", "status", "requestedAt", "failedAt"], "properties": { "id": { "type": "string" }, "trigger": { "type": "string", "enum": ["manual", "schedule", "backfill"], "description": "What triggered this delivery." }, "status": { "type": "string", "enum": ["failed"] }, "connectionIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time" }, "failedAt": { "type": "string", "format": "date-time" } } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a delivery fails." }, "DeliveryCompleted": { "title": "delivery.completed", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["delivery.completed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["destination", "delivery"], "properties": { "destination": { "$ref": "#/components/schemas/BasicDestination" }, "delivery": { "type": "object", "required": ["id", "status", "requestedAt", "completedAt"], "properties": { "id": { "type": "string" }, "trigger": { "type": "string", "enum": ["manual", "schedule", "backfill"], "description": "What triggered this delivery." }, "status": { "type": "string", "enum": ["completed"] }, "connectionIds": { "type": "array", "items": { "type": "string" } }, "requestedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" } } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a delivery completes successfully." }, "IssueId": { "title": "IssueId", "type": "string", "format": "ulid", "pattern": "^isu_[0-9A-HJKMNP-TV-Z]{26}$", "example": "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "ExpandableIssue": { "title": "ExpandableIssue", "example": "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC", "oneOf": [ { "$ref": "#/components/schemas/IssueId" }, { "$ref": "#/components/schemas/ExpandedIssue" } ] }, "IssueCode": { "title": "IssueCode", "type": "string", "description": "Stable semantic identifier for an Issue and its remediation workflow. Legacy values remain in the schema for source compatibility but are not emitted after migration.", "enum": [ "missing_permissions", "exceeded_retention_window", "invalid_source_id", "unknown_device_type", "missing_safety_configuration", "inaccessible_data", "manually_disabled", "permission_missing", "oauth_scope_missing", "subscription_required", "retention_window_exceeded", "provider_data_inaccessible", "invalid_source_identifier", "unsupported_device_type", "stream_disabled", "provider_provisioning_pending", "provider_feature_not_enabled", "missing_vehicle_identifier", "missing_vehicle_assignment", "provider_capability_not_supported", "provider_source_data_invalid", "provider_partially_configured", "managed_poll_returned_no_data", "managed_poll_failed", "data_delayed" ] }, "IssueResolutionType": { "title": "IssueResolutionType", "type": "string", "description": "How an issue is expected to be investigated or resolved.", "enum": [ "action_required", "automatic_retry", "terminal_managed", "known_limitation", "investigation_required" ] }, "Issue": { "title": "Issue", "type": "object", "x-model-category": "platform", "properties": { "id": { "$ref": "#/components/schemas/IssueId" }, "resolutionType": { "$ref": "#/components/schemas/IssueResolutionType" }, "documentationUrl": { "type": "string", "format": "uri", "description": "Direct link to the resolution guide for this semantic issue." }, "connection": { "$ref": "#/components/schemas/ExpandableConnection", "description": "The connection this issue belongs to." }, "status": { "enum": ["ongoing", "resolved"] }, "error": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/IssueCode" }, "message": { "type": "string", "example": "Failed to ingest HOS Logs, missing permissions to access Duty Status Logs" } }, "required": ["code", "message"] }, "firstReportedAt": { "$ref": "#/components/schemas/ISODateTime" }, "lastReportedAt": { "$ref": "#/components/schemas/ISODateTime" } }, "required": [ "id", "connection", "status", "error", "firstReportedAt", "lastReportedAt" ], "x-description": "An issue is a problem we encountered while ingesting data from a connection that may impact the quality or completeness of the data." }, "VIN": { "title": "VIN", "type": "string", "example": "1HGCM82633A004352" }, "IssueReported": { "title": "issue.reported", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "enum": ["issue.reported"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "issue"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "issue": { "$ref": "#/components/schemas/Issue" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-tags": ["Webhook Events"], "x-description": "Emitted when an issue with a connection has been reported." }, "IssueResolved": { "title": "issue.resolved", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "enum": ["issue.resolved"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "issue"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "issue": { "$ref": "#/components/schemas/Issue" } } } }, "required": ["id", "type", "timestamp", "detail"], "x-tags": ["Webhook Events"], "x-description": "Emitted when an issue has been manually resolved." }, "ProviderAvailability": { "title": "ProviderAvailability", "type": "string", "enum": ["available", "degraded", "unavailable"], "description": "How reliably Terminal can currently reach a provider.\n\n- `available`: requests to the provider are succeeding.\n- `degraded`: some requests are failing, or the provider is recovering from an outage. Data may be delayed.\n- `unavailable`: the provider is failing for many customers. Terminal pauses requests to it, so data is delayed until it recovers, and syncs resume automatically.", "example": "degraded" }, "ProviderAvailabilityUpdated": { "title": "provider.availability_updated", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "enum": ["provider.availability_updated"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["provider", "availability", "update"], "properties": { "provider": { "type": "object", "description": "The provider whose availability was updated.", "required": ["code", "name", "baseCode"], "properties": { "code": { "$ref": "#/components/schemas/ProviderCode" }, "name": { "type": "string", "example": "Geotab", "description": "The name of the Telematics Service Provider." }, "baseCode": { "type": "string", "example": "geotab", "description": "The base provider code that this provider is built on. Providers sharing a base code often fail together." } } }, "availability": { "type": "object", "description": "The provider's availability now and before this event. They can be equal, such as when the models an ongoing outage impacts change.", "required": ["current", "previous"], "properties": { "current": { "$ref": "#/components/schemas/ProviderAvailability" }, "previous": { "$ref": "#/components/schemas/ProviderAvailability" } } }, "update": { "type": "object", "description": "What Terminal is telling customers about the provider as of this event. `impacted` describes the full current state, not only what changed.", "required": ["impacted", "message"], "properties": { "impacted": { "type": "object", "description": "What the outage affects.", "required": ["models"], "properties": { "models": { "type": "array", "description": "The models the outage affects, named as in the provider's `supportedModels`. When the whole provider is affected, this lists every model it supports; otherwise only the models whose data is delayed or whose requests may fail. Empty once the provider is available.", "example": ["HOSLog", "HOSDailyLog"], "items": { "type": "string" } } } }, "message": { "type": "string", "description": "A human-readable summary of the update, suitable to show your users. Matches the update on Terminal's status page. The wording may change, so do not parse it.", "example": "Some HOS Log and HOS Daily Log records may be delayed due to elevated errors from Geotab." } } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-tags": ["Webhook Events"], "x-description": "Emitted when a provider's availability changes, such as during a provider outage and again once it recovers, and when the models an ongoing outage impacts change. This event is not tied to a connection: every application subscribed to it receives it for every provider." }, "UnsupportedProviderRequested": { "title": "unsupported_provider.requested", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "enum": ["unsupported_provider.requested"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["contactEmail", "provider"], "properties": { "contactEmail": { "type": "string", "format": "email", "example": "test@example.com" }, "dotNumber": { "type": "string", "example": "1234567" }, "provider": { "type": "string", "description": "The provider that was requested", "example": "people-net" }, "externalId": { "type": "string", "example": "123456789" }, "tags": { "type": "array", "items": { "type": "string" } } } } }, "required": ["id", "type", "timestamp", "detail"], "x-tags": ["Webhook Events"], "x-description": "Emitted when a customer requests an unsupported provider using our Link component.\n\nPlease note, requesting unsupported providers is an optional feature we use to help inform which integrations your customers are asking for next." }, "LinkAnalyticsEventEmitted": { "title": "link.analytics_event_emitted", "type": "object", "x-tags": ["Webhook Events"], "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["link.analytics_event_emitted"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "$ref": "#/components/schemas/LinkAnalyticsEventEmittedDetail" } }, "required": ["id", "type", "timestamp", "detail"], "x-description": "Emitted when a user performs a tracked action in the Link flow." }, "LinkAnalyticsEventEmittedDetail": { "title": "LinkAnalyticsEventEmittedDetail", "description": "Payload for a Link analytics emitted webhook event. The `event` field identifies the specific Link flow step.", "oneOf": [ { "$ref": "#/components/schemas/LinkStartedEventDetail" }, { "$ref": "#/components/schemas/AgreementAcceptedEventDetail" }, { "$ref": "#/components/schemas/ProviderSearchedEventDetail" }, { "$ref": "#/components/schemas/UnsupportedProviderSearchedEventDetail" }, { "$ref": "#/components/schemas/ProviderSelectedEventDetail" }, { "$ref": "#/components/schemas/UnsupportedProviderSelectedEventDetail" }, { "$ref": "#/components/schemas/UnsupportedProviderSubmittedEventDetail" }, { "$ref": "#/components/schemas/HelpGuideClickedEventDetail" }, { "$ref": "#/components/schemas/OAuthInitiatedEventDetail" }, { "$ref": "#/components/schemas/OAuthRedirectedEventDetail" }, { "$ref": "#/components/schemas/CreateConnectionAttemptedEventDetail" }, { "$ref": "#/components/schemas/CreateConnectionFailedEventDetail" }, { "$ref": "#/components/schemas/CreateConnectionCompletedEventDetail" } ] }, "LinkAnalyticsEventBase": { "title": "LinkAnalyticsEventBase", "type": "object", "properties": { "event": { "type": "string", "description": "Specific Link analytics event name." }, "sessionId": { "type": "string", "description": "Identifier that connects events across a single Link session." }, "language": { "title": "LinkLanguage", "type": "string", "enum": ["en", "es", "fr"], "description": "Language selected by the user in the Link flow." }, "externalId": { "type": "string", "description": "External identifier passed when initializing Link." }, "connectionId": { "$ref": "#/components/schemas/ConnectionId", "description": "Terminal connection identifier when known." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Connection tags passed when initializing Link." } }, "required": ["event", "sessionId"] }, "LinkAnalyticsOptionalProviderProperties": { "title": "LinkAnalyticsOptionalProviderProperties", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" } } }, "LinkAnalyticsProviderProperties": { "title": "LinkAnalyticsProviderProperties", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" } }, "required": ["provider"] }, "LinkAnalyticsUnsupportedProviderProperties": { "title": "LinkAnalyticsUnsupportedProviderProperties", "type": "object", "properties": { "provider": { "type": "string" } }, "required": ["provider"] }, "LinkAnalyticsSearchProperties": { "title": "LinkAnalyticsSearchProperties", "type": "object", "properties": { "query": { "type": "string", "description": "The search query entered by the user." }, "resultCount": { "type": "integer", "description": "Number of results returned." } }, "required": ["query", "resultCount"] }, "LinkAnalyticsOAuthRedirectProperties": { "title": "LinkAnalyticsOAuthRedirectProperties", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "result": { "type": "string", "enum": ["success", "error"], "description": "Outcome of the OAuth redirect." }, "error": { "type": "string", "description": "Error message when the redirect result is `error`." } }, "required": ["provider", "result"] }, "LinkAnalyticsCreateConnectionFailedProperties": { "title": "LinkAnalyticsCreateConnectionFailedProperties", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" }, "reason": { "type": "string", "enum": [ "invalid_credentials", "insufficient_permissions", "internal_server_error" ], "description": "Failure category." }, "description": { "type": "string", "description": "Human-readable user-facing failure description." } }, "required": ["provider", "reason"] }, "LinkAnalyticsCreateConnectionCompletedProperties": { "title": "LinkAnalyticsCreateConnectionCompletedProperties", "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ProviderCode" } }, "required": ["provider"] }, "LinkStartedEventDetail": { "title": "link_started", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["link_started"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsOptionalProviderProperties" } }, "required": ["event"] } ] }, "AgreementAcceptedEventDetail": { "title": "agreement_accepted", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["agreement_accepted"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsOptionalProviderProperties" } }, "required": ["event"] } ] }, "ProviderSearchedEventDetail": { "title": "provider_searched", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["provider_searched"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsSearchProperties" } }, "required": ["event", "properties"] } ] }, "UnsupportedProviderSearchedEventDetail": { "title": "unsupported_provider_searched", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["unsupported_provider_searched"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsSearchProperties" } }, "required": ["event", "properties"] } ] }, "ProviderSelectedEventDetail": { "title": "provider_selected", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["provider_selected"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsProviderProperties" } }, "required": ["event", "properties"] } ] }, "UnsupportedProviderSelectedEventDetail": { "title": "unsupported_provider_selected", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["unsupported_provider_selected"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsUnsupportedProviderProperties" } }, "required": ["event", "properties"] } ] }, "UnsupportedProviderSubmittedEventDetail": { "title": "unsupported_provider_submitted", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["unsupported_provider_submitted"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsUnsupportedProviderProperties" } }, "required": ["event", "properties"] } ] }, "HelpGuideClickedEventDetail": { "title": "help_guide_clicked", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["help_guide_clicked"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsProviderProperties" } }, "required": ["event", "properties"] } ] }, "OAuthInitiatedEventDetail": { "title": "oauth_initiated", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["oauth_initiated"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsProviderProperties" } }, "required": ["event", "properties"] } ] }, "OAuthRedirectedEventDetail": { "title": "oauth_redirected", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["oauth_redirected"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsOAuthRedirectProperties" } }, "required": ["event", "properties"] } ] }, "CreateConnectionAttemptedEventDetail": { "title": "create_connection_attempted", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["create_connection_attempted"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsProviderProperties" } }, "required": ["event", "properties"] } ] }, "CreateConnectionFailedEventDetail": { "title": "create_connection_failed", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["create_connection_failed"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsCreateConnectionFailedProperties" } }, "required": ["event", "properties"] } ] }, "CreateConnectionCompletedEventDetail": { "title": "create_connection_completed", "allOf": [ { "$ref": "#/components/schemas/LinkAnalyticsEventBase" }, { "type": "object", "properties": { "event": { "type": "string", "enum": ["create_connection_completed"] }, "properties": { "$ref": "#/components/schemas/LinkAnalyticsCreateConnectionCompletedProperties" } }, "required": ["event", "connectionId", "properties"] } ] }, "VehicleAdded": { "title": "vehicle.added", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["vehicle.added"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "vehicle"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "vehicle": { "$ref": "#/components/schemas/Vehicle" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "VehicleModified": { "title": "vehicle.modified", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["vehicle.modified"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "vehicle"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "vehicle": { "$ref": "#/components/schemas/Vehicle" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "VehicleRemoved": { "title": "vehicle.removed", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["vehicle.removed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "vehicle"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "vehicle": { "$ref": "#/components/schemas/Vehicle" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "DriverAdded": { "title": "driver.added", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["driver.added"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "driver"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "driver": { "$ref": "#/components/schemas/Driver" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "DriverModified": { "title": "driver.modified", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["driver.modified"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "driver"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "driver": { "$ref": "#/components/schemas/Driver" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "DriverRemoved": { "title": "driver.removed", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["driver.removed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "driver"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "driver": { "$ref": "#/components/schemas/Driver" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "TrailerAdded": { "title": "trailer.added", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["trailer.added"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "trailer"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "trailer": { "$ref": "#/components/schemas/Trailer" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "TrailerModified": { "title": "trailer.modified", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["trailer.modified"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "trailer"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "trailer": { "$ref": "#/components/schemas/Trailer" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "TrailerRemoved": { "title": "trailer.removed", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["trailer.removed"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "trailer"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "trailer": { "$ref": "#/components/schemas/Trailer" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "VehicleLocationUpdated": { "title": "vehicle.location_updated", "x-tags": ["Webhook Events"], "x-feature-flag": "vehicle-location-webhooks", "type": "object", "x-hidden": true, "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["vehicle.location_updated"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "location"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "location": { "$ref": "#/components/schemas/LatestVehicleLocation" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "SafetyEventAdded": { "title": "safety_event.added", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["safety_event.added"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "safetyEvent"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "safetyEvent": { "$ref": "#/components/schemas/SafetyEvent" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "SafetyEventModified": { "title": "safety_event.modified", "x-tags": ["Webhook Events"], "type": "object", "properties": { "id": { "$ref": "#/components/schemas/EventId" }, "type": { "type": "string", "enum": ["safety_event.modified"] }, "timestamp": { "$ref": "#/components/schemas/ISODateTime" }, "detail": { "type": "object", "required": ["connection", "safetyEvent"], "properties": { "connection": { "$ref": "#/components/schemas/BasicConnection" }, "safetyEvent": { "$ref": "#/components/schemas/SafetyEvent" } } } }, "required": ["id", "type", "timestamp", "detail"] }, "AgreementId": { "title": "AgreementId", "type": "string", "format": "ulid", "example": "agr_01D9ZQFGHVJ858NBF2Q7DV9MNH" }, "AgreementAcceptance": { "title": "AgreementAcceptance", "type": "object", "properties": { "agreementUrl": { "type": "string", "description": "The URL to the agreement content. The URL and content should be immutable." }, "type": { "$ref": "#/components/schemas/AgreementType" }, "ipAddress": { "type": "string", "format": "ipv4" }, "acceptedAt": { "$ref": "#/components/schemas/ISODateTime" }, "userAgent": { "type": "string", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", "format": "user-agent" } }, "required": ["agreementUrl"] }, "Agreement": { "title": "Agreement", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/AgreementId" }, "connectionId": { "$ref": "#/components/schemas/ConnectionId" }, "agreementUrl": { "type": "string", "format": "uri" }, "acceptedBy": { "type": "object", "properties": { "sourceId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } }, "acceptedAt": { "$ref": "#/components/schemas/ISODateTime" }, "location": { "type": "string", "example": "New York, NY" }, "ipAddress": { "type": "string", "format": "ipv4" }, "userAgent": { "type": "string", "format": "user-agent" } }, "required": ["id", "applicationId", "agreementUrl", "acceptedAt"] }, "AgreementType": { "title": "Agreement Type", "type": "string", "enum": [ "end-user-agreement", "isaac-data-sharing-agreement", "jj-keller-data-sharing-agreement" ] }, "ProviderRequestType": { "title": "Provider Request Type", "type": "string", "enum": ["historical_files", "provision_credentials"] }, "SyncProviderRequestType": { "title": "Sync Provider Request Type", "type": "string", "enum": ["historical_files", "provision_credentials"] }, "ProviderRequestStatus": { "title": "Provider Request Status", "type": "string", "enum": ["created", "sent", "completed", "rejected", "cancelled"] }, "ProviderRequest": { "title": "Provider Request", "type": "object", "properties": { "id": { "type": "string", "format": "ulid", "example": "requ_01D8ZQFGHVJ858NBF2Q7DV9MNC" }, "connectionId": { "type": "string", "description": "The ID of the connection this request is for" }, "syncId": { "type": "string", "description": "The ID of the sync this request is related to" }, "status": { "$ref": "#/components/schemas/ProviderRequestStatus" }, "type": { "$ref": "#/components/schemas/ProviderRequestType" }, "createdAt": { "$ref": "#/components/schemas/ISODateTime" }, "updatedAt": { "$ref": "#/components/schemas/ISODateTime" }, "sentAt": { "$ref": "#/components/schemas/ISODateTime" }, "completedAt": { "$ref": "#/components/schemas/ISODateTime" } }, "required": [ "id", "connectionId", "status", "type", "createdAt", "updatedAt" ] }, "Visibility": { "type": "string", "enum": [ "visible", "hidden_by_exclude_list", "hidden_by_include_list", "hidden_by_status", "deleted" ], "description": "Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/vehicle-driver-filtering)." }, "RawData": { "title": "RawData", "type": "object", "properties": { "provider": { "type": "string" }, "schema": { "type": "string" }, "extractedAt": { "type": "string" }, "data": { "type": "object" } }, "required": ["provider", "schema", "extractedAt", "data"] }, "CoreEntityMetadata": { "title": "CoreEntityMetadata", "type": "object", "description": "Internal metadata about the record.", "required": ["addedAt", "modifiedAt"], "properties": { "addedAt": { "$ref": "#/components/schemas/AddedAt" }, "modifiedAt": { "$ref": "#/components/schemas/ModifiedAt" }, "deletedAt": { "$ref": "#/components/schemas/DeletedAt" }, "visibility": { "type": "string", "enum": [ "visible", "hidden_by_exclude_list", "hidden_by_include_list", "hidden_by_status", "deleted" ], "example": "visible", "description": "Visibility status of a resource. Read more about hidden records [here](https://docs.withterminal.com/guides/vehicle-driver-filtering)." } } }, "SyncMode": { "title": "SyncMode", "type": "string", "enum": ["automatic", "manual"], "description": "Enum values:\n- `automatic`: Terminal will keep this connections data up to date\n- `manual`: Terminal will only sync data upon request", "default": "automatic" }, "ConnectionId": { "title": "ConnectionId", "type": "string", "format": "ulid", "example": "conn_01GV12VR4DJP70GD1ZBK0SDWFH" }, "SourceId": { "title": "SourceId", "type": "string", "example": "123456789", "description": "The ID used to represent the entity in the source system." }, "ProviderCode": { "type": "string", "example": "geotab", "description": "Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under [provider details](/providers)." }, "ISODateTime": { "title": "ISODateTime", "type": "string", "format": "date-time", "example": "2021-01-06T03:24:53.000Z", "description": "[ISO 8601](https://www.w3.org/TR/NOTE-datetime) date" }, "ConnectionStatus": { "title": "Connection Status", "type": "string", "description": "Enum values:\n- `connected`: active and authenticated connection\n- `disconnected`: connection is no longer authenticated - please ask your user to link the account again\n- `archived`: connection has been archived from view - attempts to re-connect will cause us to check the connection status again\n- `pending_deletion`: connection has been marked for deletion and is awaiting the grace period\n- `deleting`: connection data is actively being deleted - this process is irreversible\n- `deleted`: connection data has been deleted and the record is retained as a stub", "enum": [ "connected", "disconnected", "archived", "pending_deletion", "deleting", "deleted" ] }, "ProviderOptions": { "type": "object", "oneOf": [ { "type": "object", "properties": { "ingestHistoryFromSourceSystem": { "default": true, "description": "By default our system will ingest Vehicle Locations and Stat Logs from the source system. Omnitracs also supports history at a higher sample rate through a historical file process. If you are using these historical files and want to avoid mixing the data sources, set this to false.", "type": "boolean" } }, "required": [], "title": "Omnitracs Options" }, { "type": "object", "properties": { "ingestHistoryFromSourceSystem": { "default": true, "description": "By default our system will ingest Vehicle Locations and Stat Logs from the source system. Omnitracs also supports history at a higher sample rate through a historical file process. If you are using these historical files and want to avoid mixing the data sources, set this to false.", "type": "boolean" } }, "required": [], "title": "Omnitracs ES Options" }, { "type": "object", "properties": { "ingestHistoryFromSourceSystem": { "default": true, "description": "By default our system will ingest Vehicle Locations and Stat Logs from the source system. Omnitracs also supports history at a higher sample rate through a historical file process. If you are using these historical files and want to avoid mixing the data sources, set this to false.", "type": "boolean" } }, "required": [], "title": "Omnitracs XRS Options" } ] }, "ConnectionFilters": { "type": "object", "properties": { "vehicles": { "type": "object", "properties": { "status": { "type": "string", "enum": ["active", "inactive"], "description": "Filter connection to only include data related to vehicles with a specified status" }, "excludeIds": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleId" }, "description": "IDs of vehicles to exclude from data ingestion" }, "includeIds": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleId" }, "description": "IDs of vehicles to include in data ingestion (takes priority over other filters)" } } }, "drivers": { "type": "object", "properties": { "status": { "type": "string", "enum": ["active", "inactive"], "description": "Filter connection to only include data related to drivers with a specified status" }, "excludeIds": { "type": "array", "items": { "$ref": "#/components/schemas/DriverId" }, "description": "IDs of drivers to exclude from data ingestion" }, "includeIds": { "type": "array", "items": { "$ref": "#/components/schemas/DriverId" }, "description": "IDs of drivers to include in data ingestion (takes priority over other filters)" } } } }, "description": "Filters applied to connection data. Across all lists, the maximum is about 8,000 IDs. A larger update is rejected with 422 and is not saved. If one list contains most vehicles or drivers, use the opposite list: excludeIds for the ones to skip, or includeIds for the ones to keep." }, "AddedAt": { "title": "AddedAt", "type": "string", "format": "date-time", "description": "The date and time the record was ingested into Terminal. Note: this is not the date and time the record was created in the provider's system." }, "ModifiedAt": { "title": "ModifiedAt", "type": "string", "format": "date-time", "description": "The date and time the record was last updated in Terminal. Note: this is not the date and time the record was updated in the provider's system." }, "DeletedAt": { "title": "DeletedAt", "type": "string", "format": "date-time", "description": "The date and time the record was deleted from Terminal. Note: this is not the date and time the record was deleted in the provider's system." }, "SourceCreatedAt": { "title": "SourceCreatedAt", "type": "string", "format": "date-time", "description": "The date and time the record was created in the provider's system. This timestamp comes directly from the source system and represents when the data was originally created there. Note: not all providers expose this." }, "SourceUpdatedAt": { "title": "SourceUpdatedAt", "type": "string", "format": "date-time", "description": "The date and time the record was updated in the provider's system. This timestamp comes directly from the source system and represents when the data was last updated there. Note: not all providers expose this." }, "RawDataList": { "title": "RawDataList", "type": "array", "example": [], "items": { "$ref": "#/components/schemas/RawData" } }, "FaultCodeProtocol": { "type": "string", "enum": ["j1939", "obdii"], "description": "The diagnostic protocol used" }, "ExpandedGroup": { "title": "Expanded Group", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/GroupId" }, "sourceId": { "type": "string", "example": "12345" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "name": { "type": "string", "example": "California Division" }, "description": { "type": "string", "example": "Resources part of the California division" }, "parent": { "$ref": "#/components/schemas/GroupId", "description": "The parent of this group." }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "metadata"], "x-description": "A group represents a collection of assets (vehicles, trailers, drivers) defined by the provider." }, "ExpandedConnection": { "title": "Expanded Connection", "oneOf": [ { "$ref": "#/components/schemas/FullConnection" }, { "$ref": "#/components/schemas/DeletedConnection" } ], "x-description": "The connection your application has with your customer's TSP." }, "ExpandedDriver": { "title": "Expanded Driver", "type": "object", "additionalProperties": false, "examples": [], "properties": { "id": { "$ref": "#/components/schemas/DriverId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "example": "active", "description": "The status in the providers system" }, "firstName": { "type": "string", "example": "Mike" }, "middleName": { "type": "string", "example": "Bryan" }, "lastName": { "type": "string", "example": "Miller" }, "email": { "type": "string", "format": "email", "example": "driver@example.com" }, "phone": { "title": "Phone", "type": "string", "pattern": "^\\+?\\d{10,14}$", "example": "+19058084567", "description": "Phone number formatted in [E.164](https://www.twilio.com/docs/glossary/what-e164) formatting" }, "username": { "type": "string", "description": "The driver's username for login purposes", "example": "driver123" }, "license": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "123-456-789-0" } } }, "groups": { "type": "array", "description": "The groups the driver belongs to.", "items": { "$ref": "#/components/schemas/GroupId" } }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a driver in Terminal." }, "ExpandedDevice": { "title": "Expanded Device", "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/DeviceId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "type": { "description": "The type of device", "$ref": "#/components/schemas/DeviceType" }, "vehicle": { "$ref": "#/components/schemas/VehicleId", "description": "The vehicle that the device is associated with." }, "description": { "type": "string", "description": "The description or model of the device", "example": "CM31" }, "serialNumber": { "type": "string", "description": "The serial number of the device", "example": "1234567890" }, "lastConnectedAt": { "description": "The time the device was last connected", "$ref": "#/components/schemas/ISODateTime" }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "type", "metadata"], "x-description": "Type of device installed in a vehicle." }, "ExpandedVehicle": { "title": "Expanded Vehicle", "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/VehicleId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "example": "active", "description": "The status in the providers system" }, "vin": { "title": "VIN", "type": "string", "example": "1HGCM82633A004352" }, "name": { "type": "string", "example": "Big Red" }, "make": { "type": "string", "example": "Peterbilt" }, "model": { "type": "string", "example": "Model 579" }, "year": { "type": "integer", "example": 2016 }, "groups": { "type": "array", "description": "The groups the vehicle belongs to.", "items": { "$ref": "#/components/schemas/GroupId" } }, "devices": { "type": "array", "description": "The devices installed in the vehicle.", "items": { "$ref": "#/components/schemas/DeviceId" } }, "licensePlate": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "ABC-1234" } } }, "fuelType": { "enum": [ "gasoline", "diesel", "propane", "electric", "hybrid_gasoline", "hybrid_diesel", "biodiesel", "compressed_natural_gas", "liquefied_natural_gas", "ethanol", "hydrogen", "plug_in_hybrid" ], "example": "diesel" }, "fuelEfficiency": { "type": "number", "deprecated": true, "description": "This field will be removed in the future as is not commonly available from providers.", "example": 27.4 }, "fuelTankCapacity": { "description": "Maximum amount of fuel vehicle can hold in liters.", "title": "Volume In Liters", "type": "number", "example": 95.33 }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a vehicle in Terminal." }, "ExpandedTrailer": { "title": "Expanded Trailer", "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/TrailerId" }, "sourceId": { "$ref": "#/components/schemas/SourceId" }, "provider": { "$ref": "#/components/schemas/ProviderCode" }, "status": { "type": "string", "enum": ["active", "inactive"], "description": "The status in the providers system" }, "name": { "type": "string", "example": "Trailer #02323" }, "vin": { "$ref": "#/components/schemas/VIN" }, "serialNumber": { "type": "string", "example": "004352" }, "make": { "type": "string", "example": "Great Dane Trailers" }, "model": { "type": "string", "example": "Champion CP Plate Van with 24 Posts" }, "year": { "type": "integer", "example": 2013 }, "groups": { "type": "array", "description": "The groups the trailer belongs to.", "items": { "$ref": "#/components/schemas/GroupId" } }, "licensePlate": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/State" }, "number": { "type": "string", "example": "ABC-1234" } } }, "createdAt": { "$ref": "#/components/schemas/SourceCreatedAt" }, "updatedAt": { "$ref": "#/components/schemas/SourceUpdatedAt" }, "metadata": { "$ref": "#/components/schemas/CoreEntityMetadata" }, "raw": { "$ref": "#/components/schemas/RawDataList" } }, "required": ["id", "sourceId", "provider", "status", "metadata"], "x-description": "The model representing a trailer in Terminal." }, "ExpandedIssue": { "title": "Expanded Issue", "type": "object", "properties": { "id": { "$ref": "#/components/schemas/IssueId" }, "resolutionType": { "$ref": "#/components/schemas/IssueResolutionType" }, "documentationUrl": { "type": "string", "format": "uri", "description": "Direct link to the resolution guide for this semantic issue." }, "connection": { "$ref": "#/components/schemas/ConnectionId", "description": "The connection this issue belongs to." }, "status": { "enum": ["ongoing", "resolved"] }, "error": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/IssueCode" }, "message": { "type": "string", "example": "Failed to ingest HOS Logs, missing permissions to access Duty Status Logs" } }, "required": ["code", "message"] }, "firstReportedAt": { "$ref": "#/components/schemas/ISODateTime" }, "lastReportedAt": { "$ref": "#/components/schemas/ISODateTime" } }, "required": [ "id", "connection", "status", "error", "firstReportedAt", "lastReportedAt" ], "x-description": "An issue is a problem we encountered while ingesting data from a connection that may impact the quality or completeness of the data." } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer" } }, "parameters": { "ConnectionToken": { "name": "Connection-Token", "in": "header", "required": true, "schema": { "type": "string", "example": "con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4", "pattern": "^con_tkn_\\S+$" }, "description": "The token returned when a user authenticated their account. This authorizes access to a specific account." }, "Cursor": { "name": "cursor", "in": "query", "schema": { "type": "string", "format": "cursor", "pattern": "^[A-Za-z0-9+/=_-]+$", "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "description": "Pagination cursor to start requests from" }, "Limit": { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "The maximum number of results to return in a page." }, "ModifiedAfter": { "name": "modifiedAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-01-06T03:24:53.000Z" }, "description": "Only include records that were last modified after a provided date." }, "ModifiedBefore": { "name": "modifiedBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-01-06T03:24:53.000Z" }, "description": "Only include records that were last modified before a provided date." }, "StartAt": { "name": "startAt", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-01-06T03:24:53.000Z" }, "description": "Timestamp to start from - defaults to beginning of history" }, "EndAt": { "name": "endAt", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2021-01-06T03:24:53.000Z" }, "description": "Timestamp to end at - defaults to now" }, "StartDate": { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-01-06" }, "description": "Include records from on or after a specific date. Defaults to beginning of history" }, "EndDate": { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2021-01-06" }, "description": "Include records from on or before a specific date. Defaults to now" }, "DriverIds": { "name": "driverIds", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^drv_[0-9A-HJKMNP-TV-Z]{26}(\\s*,\\s*drv_[0-9A-HJKMNP-TV-Z]{26})*$" }, "description": "Comma separated list of driver IDs to filter for. Can filter up to 50 drivers at a time. Each ID must use the `drv_` prefix." }, "VehicleIds": { "name": "vehicleIds", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^vcl_[0-9A-HJKMNP-TV-Z]{26}(\\s*,\\s*vcl_[0-9A-HJKMNP-TV-Z]{26})*$" }, "description": "Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time. Each ID must use the `vcl_` prefix." }, "Raw": { "name": "raw", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified." }, "Hidden": { "name": "hidden", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Show hidden records that don't match the configured filters. Defaults to false." }, "Deleted": { "name": "deleted", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Show \"soft-deleted\" records that have been deleted from the provider. Defaults to false." }, "XApplicationId": { "name": "X-Application-Id", "in": "header", "required": false, "description": "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.", "schema": { "type": "string" } } }, "responses": { "BadRequestError": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["bad_request"] }, "message": { "type": "string", "example": "Invalid request body" }, "detail": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorPathDetail" } } }, "required": ["code", "message"] } } } }, "ConflictError": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["conflict"] }, "message": { "type": "string", "example": "Sync already in progress" }, "detail": { "type": "string", "example": "Existing sync in progress: sync_01D8ZQFGHVJ858NBF2Q7DV9MNC" } }, "required": ["code", "message"] } } } }, "UnauthorizedError": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["unauthorized"] }, "message": { "type": "string", "example": "Unauthorized Request" }, "detail": { "type": "string", "example": "Please ensure you have a valid API key" } }, "required": ["code", "message"] } } } }, "NotFoundError": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["not_found"] }, "message": { "type": "string", "example": "Resource not found" }, "detail": { "type": "string", "example": "Could not find resource with ID: 2342342" } }, "required": ["code", "message"] } } } }, "GatewayTimeoutError": { "description": "Gateway Timeout Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["gateway_timeout", "provider_timeout"], "description": "`provider_timeout` means the telematics provider did not respond in time, or responded too slowly to finish the request (for example, while paginating). Retry later or narrow the request, for example with a shorter time range or smaller `limit`. `gateway_timeout` means Terminal could not finish the request in time for another reason." }, "message": { "type": "string", "example": "Gateway Timeout" } }, "required": ["code", "message"] } } } }, "ProviderUnavailableError": { "description": "Provider Unavailable Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["provider_unavailable"] }, "message": { "type": "string", "example": "Provider is not currently available" } }, "required": ["code", "message"] } } } }, "ProviderProvisioningPendingError": { "description": "Provider Provisioning Pending", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["provider_provisioning_pending"] }, "message": { "type": "string", "example": "Provider credentials are still being provisioned" } }, "required": ["code", "message"] } } } }, "UnprocessableEntityError": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": [ "unprocessable_entity", "connection_disconnected", "insufficient_permissions", "invalid_credentials", "oauth_client_id_unknown" ], "example": "connection_disconnected" }, "message": { "type": "string", "example": "Connection must be connected to perform this action" }, "detail": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorPathDetail" }, "example": [] } }, "required": ["code", "message"] } } } }, "GoneError": { "description": "Gone", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["gone", "connection_deleted"], "example": "connection_deleted" }, "message": { "type": "string", "example": "Connection has been deleted and cannot be used" } }, "required": ["code", "message"] } } } }, "InternalServerError": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["internal_server_error"] }, "message": { "type": "string", "example": "Internal Server Error" }, "detail": { "type": "string", "example": "Something went wrong" } }, "required": ["code", "message"] } } } }, "ForbiddenError": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["forbidden"] }, "message": { "type": "string", "example": "Forbidden Request" }, "detail": { "type": "string", "example": "Please ensure the connection token matches the resource you are attempting to access." } }, "required": ["code", "message"] } } } }, "BadGatewayError": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["bad_gateway"] }, "message": { "type": "string", "example": "Provider Unavailable" }, "detail": { "type": "string", "example": "Error response received from provider with status 500" } }, "required": ["code", "message"] } } } }, "TooManyRequestsError": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "code": { "enum": ["too_many_requests"] }, "retryAfter": { "description": "The number of seconds to wait before retrying the request", "type": "integer", "example": 60 }, "message": { "type": "string", "example": "Too Many Requests" }, "detail": { "type": "string", "example": "You have exceeded your rate limit. Please try again later." } }, "required": ["code", "message"] } } } }, "NotImplementedError": { "description": "Not Implemented", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "enum": ["not_implemented"] }, "message": { "type": "string", "example": "Not Implemented" }, "detail": { "type": "string", "example": "This endpoint is not yet implemented" } }, "required": ["code", "message"] } } } } } }, "security": [ { "Authorization": [] } ], "tags": [ { "name": "Authentication" }, { "name": "Connections" }, { "name": "Data Management" }, { "name": "Drivers" }, { "name": "Groups" }, { "name": "Hours of Service" }, { "name": "IFTA" }, { "name": "Issues" }, { "name": "Link" }, { "name": "Providers" }, { "name": "Safety" }, { "name": "Trailers" }, { "name": "Vehicles" }, { "name": "Vehicle Utilization" }, { "name": "Webhook Events" } ] }