Skip to main content
GET
/
v2
/
integrations
/
connections
/
{connection_id}
/
schedules
/
{schedule_id}
Get Schedule
curl --request GET \
  --url https://api.catenatelematics.com/v2/integrations/connections/{connection_id}/schedules/{schedule_id} \
  --header 'Authorization: Bearer <token>'
{
  "consecutive_error_count": 0,
  "consecutive_error_threshold": 15,
  "cursor": "cursor-1",
  "execution_interval_seconds": 600,
  "max_concurrent_executions": 1,
  "resource": "vehicle"
}

Documentation Index

Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
connection_id
string<uuid>
required
​
schedule_id
string<uuid>
required

Response

Successful Response

API Model for reading a schedule

​
id
string<uuid>
required

Unique identifier for the schedule.

​
connection_id
string<uuid>
required

The ID of the connection that this schedule belongs to.

​
resource
enum<string>
required

The type of resource being fetched on this schedule (e.g., VEHICLE, DRIVER, HOS, IFTA).

Available options:
asset,
driver_association,
driver_vehicle_association,
driver_event_log,
driver_safety_event,
dvir_log,
dvir_log_defect,
engine_log,
engine_status,
fuel_transaction,
hos_availability,
hos_daily_snapshot,
hos_event,
hos_event_annotation,
hos_event_attachment,
hos_violation,
ifta_summary,
location_segment,
message,
user,
vehicle,
vehicle_location,
vehicle_sensor,
vehicle_region_segment,
trailer,
trailer_association,
trailer_vehicle_association,
trailer_location,
trailer_status,
workflow
​
execution_interval_seconds
integer
required

The interval between scheduled executions in seconds.

​
status
enum<string>
required

The current status of the schedule (ACTIVE, INACTIVE).

Available options:
inactive,
active,
paused,
stale,
deleted,
cancelled,
cancelled_insufficient_scope
​
consecutive_error_count
integer
required

The number of consecutive errors that have occurred for this schedule.

​
consecutive_error_threshold
integer
required

The number of consecutive errors allowed before the schedule is automatically set to INACTIVE.

​
max_concurrent_executions
integer
required

The maximum number of concurrent executions allowed for this schedule.

​
cursor
string | null

Resource-specific state used to resume incremental fetching.