GET
/
sync_runs
/
{sync_run_id}
curl --request GET \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "canceled": true,
    "completed_at": "2021-10-20T02:52:29.234Z",
    "created_at": "2021-10-20T02:51:07.546Z",
    "current_step": "Running Sync",
    "error_code": "JSON_ARRAY_ERROR",
    "error_detail": "Please make sure the field \"custom_field:Users\" with value \"jim\" is formatted as a JSON Array...",
    "error_message": "The array field being used does not appear to be valid JSON...",
    "full_sync": {
      "ui_detail": "Manually triggered by test@getcensus.com",
      "ui_tag": "Manual"
    },
    "id": 94,
    "records_failed": 123,
    "records_invalid": 123,
    "records_processed": 1,
    "records_updated": 1,
    "scheduled_execution_time": "2021-10-20T02:52:29.234Z",
    "source_record_count": 1,
    "status": "completed",
    "sync_id": 52,
    "updated_at": "2021-10-20T02:52:29.236Z"
  },
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sync_run_id
integer
required

ID of the sync run

Response

200 - application/json
data
object
required
status
enum<string>
required

The outcome of the fetch request

Available options:
success