Skip to main content

Get Syncs

GET 

/syncs

Get a list of Syncs.

Request

Query Parameters

    cursor string

    The pagination cursor value

    Example: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw
    page_size string

    Number of results to return per page

    Example: 100
    customer_id string

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    provider_name string

    The provider name

    Example: salesforce
    object_type string

    Possible values: [common, standard, custom]

    The object type to filter by

    Example: standard
    object string

    The object to filter by

    Example: contact
    entity_id string

    The entity id to filter by

    Example: e74b5a4f-f252-4a6c-940c-f35873498543

Responses

Sync

Schema
    next stringnullablerequired
    previous stringnullablerequired
    total_count number
    results object[]
  • Array [
  • oneOf
    id stringrequired
    type stringrequired

    Possible values: [object]

    object_type stringrequired

    Possible values: [common, standard, custom]

    object stringrequired
    connection_id stringrequired
    sync_config_id stringrequired
    paused booleanrequired
    provider_name stringrequired
    customer_id stringrequired
  • ]
Loading...