GET
/
syncs
curl --request GET \
  --url https://app.getcensus.com/api/v1/syncs \
  --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": [
    {
      "status": "ready",
      "id": 15135,
      "created_at": "2023-09-05T19:42:42.672Z",
      "updated_at": "2023-09-05T19:42:42.672Z",
      "match_rate_details": {
        "match_rate": 0.5,
        "match_rate_last_calculated_at": "2023-09-05T19:42:42.672Z"
      },
      "label": "New Signups to Leads",
      "operation": "mirror",
      "destination_attributes": {
        "connection_id": 15,
        "object": "user_data"
      },
      "alert_attributes": [
        {
          "type": "FailureAlertConfiguration",
          "send_for": "first_time",
          "should_send_recovery": true,
          "options": null
        },
        {
          "type": "InvalidRecordPercentAlertConfiguration",
          "send_for": "every_time",
          "should_send_recovery": false,
          "options": {
            "threshold": 10
          }
        }
      ],
      "mappings": [
        {
          "from": {
            "type": "column",
            "data": "hashed_email"
          },
          "to": "user_identifier.hashed_email_PREHASHED",
          "is_primary_identifier": true
        },
        {
          "from": {
            "type": "column",
            "data": "list_id"
          },
          "to": "list_id",
          "lookup_object": "user_list",
          "lookup_field": "name"
        },
        {
          "from": {
            "type": "constant_value",
            "data": {
              "value": "cohort_1",
              "basic_type": "text"
            }
          },
          "to": "cohort"
        }
      ],
      "advanced_configuration": {
        "data_source_country": "US, GB",
        "bulk_id_lookup": true
      },
      "mode": {
        "type": "triggered",
        "triggers": {
          "schedule": {
            "frequency": "daily",
            "hour": 10,
            "minute": 30
          }
        }
      },
      "paused": false,
      "field_behavior": "sync_all_properties",
      "field_normalization": "snake_case",
      "field_order": "alphabetical_column_name",
      "high_water_mark_attributes": {
        "use_high_water_mark_diff_type": true,
        "column_name": "updated_at"
      },
      "validate_only": true,
      "failed_run_notifications_enabled": false,
      "failed_record_notifications_enabled": false,
      "failed_record_notifications_threshold_percent": 10,
      "source_attributes": {
        "connection_id": 12,
        "object": {
          "type": "model",
          "name": "test_ads"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

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.

Required range: x <= 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

Successfully retrieved the list of syncs.

A successfully fetched list of results.