GET
/
syncs
/
{sync_id}
/
sync_runs
curl --request GET \
  --url https://app.getcensus.com/api/v1/syncs/{sync_id}/sync_runs \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 94,
      "sync_id": 52,
      "source_record_count": 15,
      "source_record_updates": 12,
      "source_record_deletes": 2,
      "source_record_invalids": 1,
      "records_processed": 14,
      "records_updated": 13,
      "records_failed": 1,
      "created_at": "2021-10-20T02:51:07.546Z",
      "updated_at": "2021-10-20T02:52:29.236Z",
      "completed_at": "2021-10-20T02:52:29.234Z",
      "scheduled_execution_time": "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",
      "canceled": true,
      "full_sync": true,
      "current_step": "Running Sync"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

sync_id
integer
required

The ID of the sync for which to list runs.

Query Parameters

page
number
default: 1

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

per_page
number
default: 25

Determines the number of results on each page. It can't exceed 100.

order
enum<string>
default: desc

Organizes the results based on their creation time, either ascending or descending.

Available options:
asc,
desc

Response

200 - application/json
status
enum<string>
required

The outcome of the request

Available options:
success
pagination
object
required

An object to help you navigate the list of results.

data
object[]
required

The list of results.