GET
/
syncs
curl --request GET \
  --url https://app.getcensus.com/api/v1/syncs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-09-05T19:42:42.672Z",
      "id": 15135,
      "status": "ready",
      "updated_at": "2023-09-05T19:42:42.672Z",
      "advanced_configuration": {
        "bulk_id_lookup": true,
        "data_source_country": "US, GB"
      },
      "alert_attributes": [
        {
          "options": null,
          "send_for": "first_time",
          "should_send_recovery": true,
          "type": "FailureAlertConfiguration"
        },
        {
          "options": {
            "threshold": 10
          },
          "send_for": "every_time",
          "should_send_recovery": false,
          "type": "InvalidRecordPercentAlertConfiguration"
        }
      ],
      "cron_expression": "* 1 * * *",
      "destination_attributes": {
        "connection_id": 123,
        "lead_union_insert_to": "<string>",
        "object": "<string>"
      },
      "failed_record_notifications_enabled": true,
      "failed_record_notifications_threshold_percent": 10,
      "failed_run_notifications_enabled": true,
      "field_behavior": "sync_all_properties",
      "field_normalization": "snake_case",
      "high_water_mark_attributes": {
        "column_name": "updated_at",
        "use_high_water_mark_diff_type": true
      },
      "label": "New Signups to Leads",
      "mappings": [
        {
          "from": {
            "data": "hashed_email",
            "type": "column"
          },
          "is_primary_identifier": true,
          "to": "user_identifier.hashed_email_PREHASHED"
        },
        {
          "from": {
            "data": "list_id",
            "type": "column"
          },
          "lookup_field": "name",
          "lookup_object": "user_list",
          "to": "list_id"
        },
        {
          "from": {
            "data": {
              "basic_type": "text",
              "value": "cohort_1"
            },
            "type": "constant_value"
          },
          "to": "cohort"
        }
      ],
      "operation": "mirror",
      "paused": true,
      "schedule_day": "Monday",
      "schedule_frequency": "daily",
      "schedule_hour": 10,
      "schedule_minute": 30,
      "source_attributes": {
        "connection_id": 123,
        "filter_segment_id": 123,
        "object": {
          "id": 1543,
          "name": "New Signups",
          "table_catalog": "data_mart",
          "table_name": "events",
          "table_schema": "publish",
          "type": "table"
        }
      },
      "triggers": {
        "dbt_cloud": {
          "job_id": "123456",
          "project_id": "12345"
        },
        "fivetran": {
          "job_id": "test_job_id",
          "job_name": "test_job_name"
        },
        "sync_sequence": {
          "sync_id": 123
        }
      },
      "validate_only": true
    }
  ],
  "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.

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