# Catch The Good Ones Docs

## Docs

- [Authentication](https://docs.catchthegoodones.com/api-reference/authentication.md): How to authenticate with the CatchTheGoodOnes API
- [Change an account's tier](https://docs.catchthegoodones.com/api-reference/change-tier.md): Upgrade or downgrade a tracked account's tier with Stripe proration
- [Create DM Template](https://docs.catchthegoodones.com/api-reference/create-dm-template.md): Create a new DM template
- [Create a segment](https://docs.catchthegoodones.com/api-reference/create-segment.md): Create a reusable segment (filter set) that can be added to streams later
- [Create a stream](https://docs.catchthegoodones.com/api-reference/create-stream.md): One-shot create: accounts + segments + schedule + delivery in one call
- [Delete DM Template](https://docs.catchthegoodones.com/api-reference/delete-dm-template.md): Delete a DM template
- [Delete a stream](https://docs.catchthegoodones.com/api-reference/delete-stream.md): Archive a campaign (preserves historical lead attribution)
- [Enrich a lead](https://docs.catchthegoodones.com/api-reference/enrich-lead.md): On-demand LinkedIn + email enrichment for a specific lead
- [Mark a lead as exported](https://docs.catchthegoodones.com/api-reference/export-lead.md): Update a lead's lifecycle to "exported" after moving it into your CRM
- [Get DM Template](https://docs.catchthegoodones.com/api-reference/get-dm-template.md): Returns a single DM template by ID
- [Get Notification Settings](https://docs.catchthegoodones.com/api-reference/get-notification-settings.md): Returns the current notification preferences for the authenticated user
- [Get a stream](https://docs.catchthegoodones.com/api-reference/get-stream.md): Inspect a single campaign with all pairs + config
- [Introduction](https://docs.catchthegoodones.com/api-reference/introduction.md): Stream-centred API for managing lead-streaming campaigns, extracting leads, and integrating Catch The Good Ones with your stack.
- [List DM Templates](https://docs.catchthegoodones.com/api-reference/list-dm-templates.md): Returns all DM templates for the authenticated user
- [List leads](https://docs.catchthegoodones.com/api-reference/list-leads.md): Cross-stream lead extraction for Zapier-style polling
- [List segments](https://docs.catchthegoodones.com/api-reference/list-segments.md): List the reusable filter sets you've authored
- [List streams](https://docs.catchthegoodones.com/api-reference/list-streams.md): List all your lead-streaming campaigns
- [List tracked accounts](https://docs.catchthegoodones.com/api-reference/list-tracked-accounts.md): List the active + sleeping tracked X accounts for the authenticated user
- [Lookup: enrich an X handle](https://docs.catchthegoodones.com/api-reference/lookups-enrich.md): One-shot LinkedIn URL + email enrichment for an X handle or profile ID
- [Lookup: enrich email for an X handle](https://docs.catchthegoodones.com/api-reference/lookups-enrich-email.md): Email-only one-shot enrichment
- [Lookup: create a segment from a description](https://docs.catchthegoodones.com/api-reference/lookups-segment-from-description.md): Natural-language description → applied filter segment
- [Get current user](https://docs.catchthegoodones.com/api-reference/me.md): Identity + remaining budgets + credit balance + subscription state in one call
- [Migrating from API v1 to v2](https://docs.catchthegoodones.com/api-reference/migration-v1-to-v2.md): Endpoint and field changes from the legacy API to the stream-centred v2 surface (audit 086 amendment 12, 2026-06).
- [Re-test a stream](https://docs.catchthegoodones.com/api-reference/re-test-stream.md): Re-classify cached followers against the campaign's segments
- [Run a stream now](https://docs.catchthegoodones.com/api-reference/run-stream.md): Trigger a sync across every pair in a campaign
- [Sleep a tracked account](https://docs.catchthegoodones.com/api-reference/sleep-tracked-account.md): Pause an account: decrements Stripe quantity but preserves history + stream pairs
- [Get leads from a stream](https://docs.catchthegoodones.com/api-reference/stream-leads.md): Extract leads scoped to one campaign
- [Get a stream run](https://docs.catchthegoodones.com/api-reference/stream-run-status.md): Check the status + progress log of a single sync run
- [List runs for a stream](https://docs.catchthegoodones.com/api-reference/stream-runs.md): Sync run history scoped to one campaign
- [Submit feedback on a lead](https://docs.catchthegoodones.com/api-reference/submit-feedback.md): Mark a lead as good or bad. Feedback is per-(lead, segment) pair.
- [List sync runs (flat)](https://docs.catchthegoodones.com/api-reference/sync-history.md): Cross-stream flat list of recent sync runs
- [Update DM Template](https://docs.catchthegoodones.com/api-reference/update-dm-template.md): Update an existing DM template
- [Update Notification Settings](https://docs.catchthegoodones.com/api-reference/update-notification-settings.md): Update one or more notification preferences
- [Update a stream](https://docs.catchthegoodones.com/api-reference/update-stream.md): Update any setting on a campaign. Pairs are full-replace.
- [Wake a tracked account](https://docs.catchthegoodones.com/api-reference/wake-tracked-account.md): Resume a slept account: re-activates syncing and increments Stripe quantity
- [Webhooks](https://docs.catchthegoodones.com/api-reference/webhooks.md): Register and manage webhook subscriptions for real-time notifications
- [Adding X Accounts](https://docs.catchthegoodones.com/help/adding-x-accounts.md): How to add and manage tracked X accounts
- [Using AI to Describe Your Audience](https://docs.catchthegoodones.com/help/ai-describe-filters.md): Let AI set your filters from a plain English description
- [API Key Management](https://docs.catchthegoodones.com/help/api-key.md): Generate and manage your API key for programmatic access
- [Getting Started](https://docs.catchthegoodones.com/help/getting-started.md): Your first steps with Catch The Good Ones
- [Notifications](https://docs.catchthegoodones.com/help/notifications.md): Set up email and Telegram notifications for new discoveries
- [Setting Up Filters](https://docs.catchthegoodones.com/help/setting-up-filters.md): How to configure your saved searches to find the right people
- [Sync Budget](https://docs.catchthegoodones.com/help/sync-budget.md): Understanding your sync budget and the Pro boost feature
- [Sync Schedule](https://docs.catchthegoodones.com/help/sync-schedule.md): How to configure when your syncs run
- [Understanding Your Leads page](https://docs.catchthegoodones.com/help/understanding-dashboard.md): How to read and use the Leads page
- [Waitlisted Platforms](https://docs.catchthegoodones.com/help/waitlisted-platforms.md): Instagram, TikTok, and YouTube platform support

## OpenAPI Specs

- [openapi](https://docs.catchthegoodones.com/api-reference/openapi.json)