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>'
{
  "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"
    }
  ],
  "pagination": {
    "last_page": 10,
    "next_page": 3,
    "page": 2,
    "per_page": 25,
    "prev_page": 1,
    "total_records": 14
  },
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

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

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
data
object[]
required

The list of results.

pagination
object
required

An object to help you navigate the list of results.

status
enum<string>
required

The outcome of the request

Available options:
success