GET
/
sync_runs
/
{sync_run_id}
/
records
curl --request GET \
  --url https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/records \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "record_payload": {
        "ID": "id_1234",
        "NAME": "Hello World"
      },
      "identifier": "id_1234",
      "batch_started_at": "2024-06-28T21:33:54Z",
      "batch_completed_at": "2024-06-28T21:33:54Z",
      "operation": "upsert",
      "status": "succeeded",
      "status_message": ""
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sync_run_id
integer
required

ID of the sync run

Query Parameters

​
primary_identifier
string

Filter records by the primary identifier.

​
status
enum<string>

Filter records by successfully synced, invalid in source, or rejected by destination.

Available options:
succeeded,
rejected,
invalid
​
operation
enum<string>

Filter by whether Census tried to create or update the record (upsert) or delete the record (delete) in the destination.

Available options:
upsert,
delete
​
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.

Required range: x < 100

Response

200
application/json
Successfully retrieved records.
​
status
enum<string>
required

The outcome of the fetch request.

Available options:
success
​
data
object[]
required

Was this page helpful?

Raise issue
Fetch sample skipped recordsFetch Records Count