Fetch Records

Retrieves records synced during a given sync run. A primary_identifier can be specified to fetch information about a single record. Additional filters such as operation and status are available as well.

Request schema

Path parameters

sync_run_id

integerrequired

ID of the sync run

Query parameters

primary_identifier

string

Filter records by the primary identifier.

status

string

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

enum:

"succeeded""rejected""invalid"

operation

string

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

enum:

"upsert""delete"

page

number

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

default:

per_page

number

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

default:

maximum:

100

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/sync_runs/{sync_run_id}/records

GET /api/v1/sync_runs/{sync_run_id}/records?primary_identifier=SOME_STRING_VALUE&status=SOME_STRING_VALUE&operation=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved records.

404

Resource not found.

410

Gone - This sync run had sync tracking records, but they have expired and aren't available for download.

`200`

status

stringrequired

The outcome of the fetch request.

enum:

"success"

data

arrayrequired

record_payload

object

A JSON representation of the record payload sent to the destination.

example:

{ "ID": "id_1234", "NAME": "Hello World" }

identifier

string

The identifier of the record.

example:

id_1234

batch_started_at

string

When the batch started.

format:

date-time

example:

2024-06-28T21:33:54Z

batch_completed_at

string

When the batch completed.

format:

date-time

example:

2024-06-28T21:33:54Z

operation

string | null

The operation performed on the record.

example:

upsert

status

string

Status of the operation performed on the record. Possible values are:

succeeded: Operation was successful.
rejected: Operation was rejected.
NULL: Record identifier was null.
DUPLICATE: Record was a duplicate.
invalid: Record was invalid.

enum:

"succeeded""rejected""NULL""DUPLICATE""invalid"

status_message

string | null

The status message of the operation. Typically used for error messages on rejected records.

`404`

status

integer

HTTP status code.

enum:

"404"

`410`

status

string

The outcome of the fetch request.

enum:

"error"

message

string

example:

Records retention period has expired

{
  "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": ""
    }
  ]
}