Sync
Get all syncs
- Documentation
- Contact Us
- Introduction
Link Token
Sync
Destination
Source
Object
Connection
Customer Data
Overview
API Reference
Sync
Get all syncs
GET
/
syncs
X-API-KEY
string
*
X-API-KEY
Required
string
curl --request GET \
--url https://api.fabra.io/syncs \
--header 'X-API-KEY: <api-key>'
{
"syncs": [
{
"id": 10,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 123,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}
]
}
Authorizations
X-API-KEY
string
headerrequiredResponse
200 - application/json
syncs
object[]
syncs.id
integer
syncs.display_name
string
syncs.end_customer_id
string
syncs.source_id
integer
syncs.destination_id
integer
syncs.object_id
integer
syncs.namespace
string
syncs.table_name
string
syncs.custom_join
string
syncs.cursor_field
string
syncs.primary_key
string
syncs.frequency
integer
syncs.frequency_units
enum<string>
Available options:
minutes
, hours
, days
, weeks
syncs.field_mappings
object[]
syncs.field_mappings.source_field_name
string
syncs.field_mappings.destination_field_name
string
curl --request GET \
--url https://api.fabra.io/syncs \
--header 'X-API-KEY: <api-key>'
{
"syncs": [
{
"id": 10,
"display_name": "Event Sync",
"end_customer_id": "abc123",
"source_id": 1,
"destination_id": 2,
"object_id": 3,
"namespace": "end_customer_bigquery_dataset",
"table_name": "end_customer_events",
"custom_join": "select * from events join additional_properties on events.id = additional_properties.event_id;",
"cursor_field": "updated_at",
"primary_key": "event_id",
"frequency": 123,
"frequency_units": "minutes",
"field_mappings": [
{
"source_field_name": "event_name",
"destination_field_name": "event"
}
]
}
]
}