GET
/
v1
/
syncs
curl --request GET \
  --url https://api.sequin.io/v1/syncs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
      "provider": "stripe",
      "name": "Choam Corp - HubSpot Production",
      "status": "active",
      "org_id": "75958cea-c981-4116-9a0d-c1e99e826688",
      "health": {
        "status": "healthy",
        "sync_id": "c906b4a4-0cda-4f46-bd80-255f570c195d"
      },
      "collection_ids": ["hubspot:contact", "hubspot:company"],
      "rate_limit": {
        "allowed_requests": 1000,
        "interval": 60,
        "max_concurrent_requests": 0
      },
      "credential_id": "27879937-bd5d-490b-a943-edf486b04300",
      "credential": {
        "id": "27879937-bd5d-490b-a943-edf486b04300",
        "provider": "stripe",
        "properties": {
          "kind": "stripe_key",
          "name": "TEST ACCOUNT",
          "secret": "***********",
          "test": true
        },
        "oauth_app_id": null,
        "oauth_app": {
          "kind": "sequin"
        },
        "metadata": { "custom_credential_property": 42 },
        "created_at": "2023-12-15 01:29:29",
        "updated_at": "2023-12-15 01:29:29"
      },
      "max_age_days": 365,
      "sync_frequency": "continuous",
      "initial_backfill_completed_at": "2023-12-15 01:29:29",
      "metadata": { "custom_property": 42 },
      "created_at": "2023-12-15 01:29:29",
      "updated_at": "2023-12-15 01:29:29"
    },
    { ... },
    { ... }
  ]
}

​
Request parameters

provider
string

Filter for syncs for this provider (e.g. github, stripe, etc).

health.status
string

Filter for syncs with this health status (e.g. ok, error, etc).

This filter coming soon.
name
string

Filter for syncs matching this name.

metadata
json

Filter for syncs matching the properties supplied in this map. For example, {"custom_property": 42} will return all syncs with a custom_property of 42.

​
Response fields

id
string

ID of the sync.

provider
string

Provider of the sync (e.g. github, stripe, etc). See the list of possible values.

name
string

Name of the sync, which you provide on create or update.

status
string

Whether the sync is active or disabled.

health
object

Health of the sync. Learn more about the health object.

collection_ids
array

IDs of the collections that are synced by this sync.

rate_limit
object

Rate limit of the sync. Learn more about the rate limit object.

credential
object

Credential for the sync. This will usually consist of an access token and a refresh token Sequin uses to make requests. This object is polymorphic, see the list of possible shapes.

max_age_days
number

By default, Sequin syncs all data from the API regardless of age. When you set max_age_days, Sequin will only sync and retain records that have been created or updated in the last max_age_days days.

Defaults to null, which means no age limit.

sync_frequency
string

One of continuous or 4h. If continuous, Sequin will run a continuous sync to sync data as fast as possible from the API. If 4h, Sequin will sync data every 4 hours.

initial_backfill_completed_at
string

Timestamp of when the initial backfill was completed, in ISO 8601 format. Is null if the initial backfill has not yet completed.

metadata
object

Metadata for the sync. This is a JSON object that you can use to store any additional information you want to associate with the sync.

created_at
string

Timestamp of when the sync was created, in ISO 8601 format.

updated_at
string

Timestamp of when the sync was last updated, in ISO 8601 format.

Was this page helpful?

ErrorsGet a sync