Get a run

curl --request GET \
  --url https://api.stackone.com/v2/data_sync/runs/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.stackone.com/v2/data_sync/runs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stackone.com/v2/data_sync/runs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.stackone.com/v2/data_sync/runs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/v2/data_sync/runs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "account_id": "<string>",
  "action_id": "<string>",
  "is_failure": true,
  "sync_mode": "full",
  "schedule_id": "<string>",
  "status": "running",
  "trigger_source": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "record_count": 123,
  "record_stats": {
    "added": 123,
    "updated": 123,
    "unchanged": 123,
    "removed": 123
  },
  "error": {
    "message": "<string>",
    "code": "<string>"
  },
  "workflow_id": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

GET

data_sync

runs

{id}

Get a run

curl --request GET \
  --url https://api.stackone.com/v2/data_sync/runs/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.stackone.com/v2/data_sync/runs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stackone.com/v2/data_sync/runs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.stackone.com/v2/data_sync/runs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/v2/data_sync/runs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "account_id": "<string>",
  "action_id": "<string>",
  "is_failure": true,
  "sync_mode": "full",
  "schedule_id": "<string>",
  "status": "running",
  "trigger_source": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "synced_at": "2023-11-07T05:31:56Z",
  "record_count": 123,
  "record_stats": {
    "added": 123,
    "updated": 123,
    "unchanged": 123,
    "removed": 123
  },
  "error": {
    "message": "<string>",
    "code": "<string>"
  },
  "workflow_id": "<string>"
}

{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}

{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

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

string

required

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

Response

The run was retrieved.

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.

Show child attributes

error

object | null

Why the run failed or stopped early.

Show child attributes

workflow_id

string | null

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

Accounts

Actions

Connect Sessions

Connector Profiles

Connectors

Data Sync

Logs

MCP

Webhooks

Get a run

Authorizations

Path Parameters

Response