Skip to main content
GET
Get a run

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique identifier of the run (the Temporal workflow run id).

Response

The run was retrieved.

id
string
required

The unique identifier of the run (the Temporal workflow run id).

account_id
string
required

The linked account this run synced.

action_id
string
required

The action this run executed.

is_failure
boolean
required

Whether the run failed to do its whole job and needs attention.

sync_mode
enum<string>
required

Whether the run re-fetched everything (full) or only records changed since the last run (incremental).

Available options:
full,
incremental
schedule_id
string | null

The schedule this run belongs to; null for legacy runs not tied to a schedule.

status
enum<string> | null

Why the run ended, or running; null for runs recorded before statuses were tracked. truncated stopped early; a full sync that stops early is not served, and reads keep the last complete sync. no_records_found and unexpected_record_count are full syncs held because they returned no records, or were missing more than 30% (and at least 10) of the previous sync's records; they are not served and send no events, and the next full sync that is held the same way is served. failed is any failure not classified more specifically.

Available options:
running,
success,
truncated,
quota_exceeded,
invalid_config,
timed_out,
provider_auth_failed,
provider_rate_limited,
provider_error,
incomplete,
no_records_found,
unexpected_record_count,
failed,
null
trigger_source
string | null

What triggered the run — initial (fired when a schedule is created) or schedule (a Temporal cadence fire).

started_at
string<date-time> | null

When the run began; null if it has not started.

completed_at
string<date-time> | null

When the run finished; null while running.

synced_at
string<date-time> | null

When the synced data became available for read; null unless the run's data is served, which a full sync that stopped early is not.

record_count
number | null

The number of records written by the run; set for runs that completed or stopped early, null for runs that failed with an error, were refused before syncing, or are still running.

record_stats
object | null

How the record count breaks down. null when the run failed, was abandoned, or was a full sync that stopped early.

error
object | null

Why the run failed or stopped early.

workflow_id
string | null

The Temporal workflow id, stable across replays; useful for cross-referencing the run.