Skip to main content
GET
/
api
/
v1
/
sync-settings
Get Sync Settings
curl --request GET \
  --url https://www.catchthegoodones.com/api/v1/sync-settings
{
  "timezone": "America/New_York",
  "tiers": {
    "pro": {
      "syncTimes": ["09:00", "15:00", "21:00"],
      "nextSyncAt": "2026-04-17T15:00:00.000Z",
      "maxSyncTimes": 4,
      "maxSyncsPerDay": 4,
      "accounts": [
        {
          "id": 1,
          "xHandle": "youraccount",
          "tier": "top",
          "isActive": true,
          "savedSearchId": 3,
          "totalFollowersSynced": 5000,
          "totalLikersSynced": 1200,
          "savedSearchDescription": "Tech founders",
          "syncsUsedToday": 1
        }
      ]
    }
  },
  "resourcesUsedThisPeriod": 42,
  "budgetSkipUntil": null,
  "daysRemainingInPeriod": 14,
  "isTrialing": false,
  "isFreeTier": false
}
Returns your timezone, per-tier sync schedules, accounts grouped by tier, and budget information.

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer ctgo_your_api_key_here

​
Example

curl https://www.catchthegoodones.com/api/v1/sync-settings \
  -H "Authorization: Bearer ctgo_your_api_key_here"

​
Response

{
  "timezone": "America/New_York",
  "tiers": {
    "pro": {
      "syncTimes": ["09:00", "15:00", "21:00"],
      "nextSyncAt": "2026-04-17T15:00:00.000Z",
      "maxSyncTimes": 4,
      "maxSyncsPerDay": 4,
      "accounts": [
        {
          "id": 1,
          "xHandle": "youraccount",
          "tier": "top",
          "isActive": true,
          "savedSearchId": 3,
          "totalFollowersSynced": 5000,
          "totalLikersSynced": 1200,
          "savedSearchDescription": "Tech founders",
          "syncsUsedToday": 1
        }
      ]
    }
  },
  "resourcesUsedThisPeriod": 42,
  "budgetSkipUntil": null,
  "daysRemainingInPeriod": 14,
  "isTrialing": false,
  "isFreeTier": false
}

​
Response fields

FieldTypeDescription
timezonestring or nullIANA timezone (e.g. "America/New_York") or null if not set
tiersobjectPer-tier schedule and account information, keyed by "starter", "growth", or "pro"
tiers[tier].syncTimesarrayConfigured sync times in HH:MM format
tiers[tier].nextSyncAtstring or nullISO 8601 timestamp of the next scheduled sync
tiers[tier].maxSyncTimesintegerMaximum number of sync times allowed for this tier
tiers[tier].maxSyncsPerDayintegerMaximum syncs per day for this tier
tiers[tier].accountsarrayTracked accounts on this tier with sync stats
resourcesUsedThisPeriodintegerTotal resources consumed in the current billing period
budgetSkipUntilstring or nullISO 8601 date until syncs are paused (Pro boost feature)
daysRemainingInPeriodinteger or nullDays remaining in the billing period (Pro tier only)
isTrialingbooleanWhether the user is on a free trial
isFreeTierbooleanWhether the user is on the free tier (subscriptionStatus = 'free_user'). Free-tier users cannot call the sync endpoint and should upgrade first.