🧪 Get Workflow
Get detailed information about a specific workflow.
This endpoint is available for early access. The core schema is stable, but minor details — such as field names or added fields — may change before it becomes generally available. Backward compatibility is not guaranteed.
See API Stability & Versioning for details on provisional endpoints.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the workflow.
Query Parameters
Include the raw data from the telematics provider. Useful for auditing or accessing fields not normalized by Catena
Response
Successful Response
Workflow model for API responses.
Internal fleet identifier.
Unique identifier of the record at Catena Telematics.
Immutable: The datetime the record was ingested into Catena Telematics.
The dateime the record was last modified in Catena Telematics.
Unique identifier of the connection at Catena Telematics through which this record was ingested. A connection represents a Fleet/TSP pairing.
The underlying telematics platform that provided this data (e.g., samsara, motive, hos247). Note: Some platforms like hos247 offer white-labeling, so multiple TSPs may share the same source_name — use tsp_id or tsp_slug to identify the specific ELD provider.
ada, ai_eld, air_eld, alfa_eld, alpha_eld, als, anytrek_pro, anytrek_classic, apex_eld, apollo, apollocloud, ascend, att, awaregps, azuga, bigroad, bluehorse_eld, blueinktech, bouncie, budgetgps, catena_simulator, captain_eld, carrier_lynx, club_eld, counting_trucks_eld, cyntrx, digital_eld, dragon_eld, drive_hos, drive_hos_v2, driver_tech, dsg_elogs, dynamic_eld, eighteighteight_eld, eld_88, eld_books, eld_mandate, eld_mandate_prime, eroad, eva_eld, evo_eld, expressway_eld, extreme_eld, ezlogz, ez_lynk, factor_eld, firstgate, fleetcomplete, fleetcompletehub, fleethunt, fleetpulse, fleetsharp, fleetup, fm, forwardthinking, forza_eld, geotab, gpsinsight, gpstab, gpstrackit, grand_eld, greenlight, groundhog, hcss, hos247, hutch, intellishift, ironman_eld, isaac, jjkeller, kinexaiot, knight_eld, konexial, lioneight, linxup, loop_eld, lucid_eld, luna_eld, lytx, lytxv3, mapon, matrack, maven, mdm_eld, mobilefleet, moonlight_eld, motion_eld, motive, my_drivebook, my_logs_eld, nero, netradyne, new_eld_world, nextgen_eld, nextraq, omnitracs, onestep, ontime_eld, optima, orbcomm, orient_eld, panda_eld, payd, peak_eld, peoplenet, phillips_connect, phoenix, pop_eld, prologs, proride_eld, qualitylogs_eld, randmcnally, rastrac, raven, redfox, regulog_eld, ridehub, roadeazy, rock_eld, rollingtrans, routemate, royal_eld, safelane, samsara, selectivedrive, simba_eld, skybitz, smart_elds, sparkle_eld, spireon, sun_eld, surfsight, swift, switchboard, synergy_eld, teletracnavman, teletracnavman_director, telogis, tenna, thermo_king, think, tive, topcompliance_eld, traccar, trackease_eld, trackpro, traclog, transflo, trimble, truckford, truckspy, truckx, trueroad_eld, tt, txt_eld, us_fast_eld, verizon_connect, vista_eld, vistracks, vlog_eld, vulcansols_eld, wialon, webfleet, xplore_eld, zigzag_eld, zms_eld, zonar, zubie Unique identifier of the record in the TSP. Note: we generate a unique composite key based on available fields if the TSP does not provide an unique ID.
SHA-256 hash of the source data payload. Note: we use it internally for idempotence and deduplication.
64External fleet reference in the partner system.
The datetime the record was logically deleted from Catena Telematics.
Unique identifier of the TSP at Catena Telematics from which this record was ingested.
Human readable slug of the TSP at Catena Telematics from which this record was ingested.
Raw source payload as ingested from the TSP. Note: use it for audit/debugging.
Datetime of when the underlying event/observation occurred, as reported by the TSP, or the moment it was ingested by us if not available in the source data.
Unique identifier for the execution that ingested this record into Catena Telematics. Note: useful for tracing.
Unique identifier for schedule that triggered this record's execution. Note: useful for tracing.
Additional data available in the TSP (e.g., we may have external_id, provider_resource_id, etc. — this field captures all those extra attributes in a flexible way).
Unique vehicle identifier at Catena Telematics.
Unique driver identifier at Catena Telematics.
External source system vehicle identifier.
External source system driver identifier.
Current status of the planned job, route, dispatch, or workflow.
PLANNED, ACTIVE, COMPLETED, CANCELLED Datetime when the workflow started.
Datetime when the workflow ended.
Total workflow distance in meters.
Workflow-level instructions.
Ordered stops/locations within the workflow.