Skip to content

API reference

Read scoped schedule and delivery status

GET
/v1/pilot/schedules/{scheduleId}

Requires query:read. Returns the schedule, latest occurrence and latest successfully verified delivery. No tokens, grant envelopes, provider errors or arbitrary internal fields are returned. Unknown stored error text becomes automation_unavailable. Implemented and locally tested; new live scheduled delivery and controlled failure/recovery acceptance remain pending.

scheduleId
required
string
/^[A-Za-z0-9_-]{1,128}$/

Read scoped schedule and delivery status.

Times are epoch milliseconds. lastDelivered records the latest successful verification. latest.id is the pipelineId accepted by redrive. Source and export status remain separate; an export failure does not retract published source data.

object
schedule
required
object
id
required
string
/^[A-Za-z0-9_-]{1,128}$/
revision
required
integer
>= 1 <= 9007199254740991
enabled
required
boolean
nextDueAt
required
integer
<= 9007199254740991
timezone
required

A timezone accepted by the runtime IANA timezone formatter; selected from homogeneous published source heads.

string
<= 128 characters /^[A-Za-z0-9_+./-]+$/
windowDays
required
integer
>= 1 <= 31
lastErrorCode
required

Fixed operational diagnosis, or null. Unknown stored text is replaced with automation_unavailable. These fields are not HTTP status codes.

string | null
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict sheet_verification_failed credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable source_not_fully_published property_timezone_changed destination_capacity_exhausted invalid_export_evidence publication_conflict export_integrity_failure export_identity_mismatch export_evidence_missing raw_commit_failed lease_lost planning_integrity_failure sheet_invalid_generation sheet_generation_conflict export_query_invalid export_query_forbidden export_query_superseded export_query_unavailable export_unavailable retry_after_exceeds_policy raw_integrity_failure publication_rejected window_in_progress attempts_exhausted analytics_load_failed analytics_load_unavailable sync_unavailable query_unavailable
latest
required
Any of:
object
id
required
string
/^[A-Za-z0-9_-]{1,128}$/
dueAt
required
integer
<= 9007199254740991
sourceRunId
required
string
/^[A-Za-z0-9_-]{1,128}$/
destinationOrdinal
required
integer
>= 1 <= 9007199254740991
state
required
string
Allowed values: source_pending source_running export_pending succeeded superseded failed cancelled
sourceAttempts
required
integer
<= 4
sourceNextAttemptAt
required
integer
<= 9007199254740991
errorCode
required

Fixed operational diagnosis, or null. Unknown stored text is replaced with automation_unavailable. These fields are not HTTP status codes.

string | null
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict sheet_verification_failed credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable source_not_fully_published property_timezone_changed destination_capacity_exhausted invalid_export_evidence publication_conflict export_integrity_failure export_identity_mismatch export_evidence_missing raw_commit_failed lease_lost planning_integrity_failure sheet_invalid_generation sheet_generation_conflict export_query_invalid export_query_forbidden export_query_superseded export_query_unavailable export_unavailable retry_after_exceeds_policy raw_integrity_failure publication_rejected window_in_progress attempts_exhausted analytics_load_failed analytics_load_unavailable sync_unavailable query_unavailable
exportId
required
string
/^[A-Za-z0-9_-]{1,128}$/
exportState
required
string
Allowed values: pending running succeeded superseded failed cancelled
exportAttempts
required
integer
<= 4
exportNextAttemptAt
required
integer
<= 9007199254740991
exportErrorCode
required

Fixed operational diagnosis, or null. Unknown stored text is replaced with automation_unavailable. These fields are not HTTP status codes.

string | null
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict sheet_verification_failed credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable source_not_fully_published property_timezone_changed destination_capacity_exhausted invalid_export_evidence publication_conflict export_integrity_failure export_identity_mismatch export_evidence_missing raw_commit_failed lease_lost planning_integrity_failure sheet_invalid_generation sheet_generation_conflict export_query_invalid export_query_forbidden export_query_superseded export_query_unavailable export_unavailable retry_after_exceeds_policy raw_integrity_failure publication_rejected window_in_progress attempts_exhausted analytics_load_failed analytics_load_unavailable sync_unavailable query_unavailable
visibleOrdinal
required
integer | null
>= 1 <= 9007199254740991
lastDelivered
required
Any of:
object
pipelineId
required
string
/^[A-Za-z0-9_-]{1,128}$/
destinationOrdinal
required
integer
>= 1 <= 9007199254740991
visibleOrdinal
required
integer
>= 1 <= 9007199254740991
completedAt
required
integer
<= 9007199254740991

invalid_request — the URL carried a query delimiter.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: invalid_request invalid_json invalid_schedule
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

Missing, expired, revoked or reassigned key, including changes before response release.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed value: unauthorized
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable
WWW-Authenticate
required
string
Allowed value: Bearer

forbidden — the key lacks query:read.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: forbidden source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

schedule_not_found in this workspace.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: not_found destination_not_found schedule_not_found pipeline_not_found connection_unavailable
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable

method_not_allowed — use the method named in Allow.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed value: method_not_allowed
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable
Allow
required
string
Allowed value: GET

automation_configuration_unavailable, credential_configuration_unavailable, or automation_unavailable.

object
error
required
object
code
required
string
Allowed values: invalid_request invalid_json invalid_schedule unsupported_media_type unsupported_encoding request_too_large unauthorized forbidden not_found method_not_allowed destination_not_found schedule_not_found pipeline_not_found connection_unavailable source_permission_required destination_permission_required schedule_enable_forbidden schedule_inactive destination_conflict destination_creation_unconfirmed destination_unavailable timezone_unverified timezone_conflict schedule_conflict redrive_conflict sheet_capacity_exhausted sheet_layout_conflict credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_auth_failed provider_rate_limited provider_unavailable automation_unavailable
message
required
string
error
object
code
Allowed values: credential_configuration_unavailable automation_configuration_unavailable credential_unavailable credential_busy provider_rate_limited automation_unavailable
error
object
code
Allowed values: invalid_request unauthorized forbidden schedule_not_found method_not_allowed automation_configuration_unavailable credential_configuration_unavailable automation_unavailable