API ReferenceSchedules

Get schedule

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

scheduleIdstringRequiredformat: "uuid"
Schedule ID

Response

Schedule details
contactIdstringformat: "uuid"
Contact to call on each execution
createdAtdatetime
When the schedule was created
flowIdstringformat: "uuid"

Flow (conversation script) used for the call

frequencyenum
How often the schedule repeats
fromPhoneNumberstring
Caller ID phone number in E.164 format
idstringformat: "uuid"
Unique identifier for the schedule
maxRetriesinteger
Maximum retry attempts per execution
namestring

Human-readable name for the schedule

providerIdstringformat: "uuid"
VoIP provider used for routing
retryDelayMinutesinteger
Minutes between retry attempts
retryOnFailureboolean
Whether failed calls are retried
runCountinteger
Number of times the schedule has executed so far
scheduleTimestring

Time of day in HH:MM format

statusenum
Current status of the schedule
timezonestring

IANA timezone used for schedule_time interpretation

cronExpressionstring or nullOptional

Custom cron expression (when frequency is custom_cron)

dayOfMonthinteger or nullOptional

Day of month (1-28)

daysOfWeeklist of integers or nullOptional

Days of week (1=Monday through 7=Sunday)

endDatedate or nullOptional
Date after which the schedule will not execute
flowVersionstring or nullOptional
Pinned flow version at time of schedule creation
lastRunAtdatetime or nullOptional
Last execution time in UTC
maxRunsinteger or nullOptional

Maximum number of executions before auto-completing

nextRunAtdatetime or nullOptional
Next scheduled execution time in UTC

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error