Skip to main content

Get SyncRuns

GET 
/sync-runs

Get a list of SyncRuns.

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]

    Example: standard
    object string

    The object to filter by

    Example: account
    entity_id string

    The entity id to filter by

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

    The status to filter by (case-insensitive)

    Example: SUCCESS
    start_timestamp string

    The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.

    Example: >2021-01-06T03:24:53.434326Z
    end_timestamp string

    The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.

    Example: >2021-01-06T03:24:53.434326Z

Responses​

SyncRun

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

    Possible values: [common, standard, custom]

    object stringrequired
    error_message stringnullablerequired
    start_timestamp stringrequired
    end_timestamp stringnullablerequired
    application_id stringrequired
    customer_id stringrequired
    provider_name provider_namerequired

    Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

    category categoryrequired

    Possible values: [crm, engagement, enrichment, marketing_automation, no_category]

    connection_id stringrequired
    status stringrequired

    Possible values: [SUCCESS, IN_PROGRESS, FAILURE]

    num_records_synced numbernullablerequired
  • ]
Loading...