Skip to main content
GET
/
syncs
/
test_status
Fetch test sync run status
curl --request GET \
  --url https://app.getcensus.com/api/v1/syncs/test_status \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "id": 94,
    "created_at": "2021-10-20T02:51:07.546Z",
    "updated_at": "2021-10-20T02:52:29.236Z",
    "completed_at": "2021-10-20T02:52:29.234Z",
    "error_code": "JSON_ARRAY_ERROR",
    "error_message": "The array field being used does not appear to be valid JSON...",
    "error_detail": "Please make sure the field \"custom_field:Users\" with value \"jim\" is formatted as a JSON Array...",
    "status": "completed",
    "sample_record": {
      "ID": "id_1234",
      "NAME": "Hello World"
    },
    "sample_record_failed": false,
    "current_step": "Prepare Sync"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Query Parameters

​
sync_run_id
integer
required

ID of the test sync run to check status for

Example:

1234567890

Response

200 - application/json

Test sync run status retrieved successfully.

​
status
enum<string>
required

The outcome of the fetch request

Available options:
success
Example:

"success"

​
data
object
required