# SphereScout

## Docs

- [SphereScout: B2B Contact Database Overview](https://docs.spherescout.io/introduction.md): Access 50M+ local business contacts across 20+ countries. Search by industry and location, filter by contact type, and export to CSV instantly.
- [Get started with SphereScout in minutes](https://docs.spherescout.io/quickstart.md): Sign up for free, run your first search, export contacts to CSV, and import them into your CRM — no credit card required to get started.
- [Create and configure your SphereScout account](https://docs.spherescout.io/account-setup.md): Sign up with email or Google, log in to your dashboard, reset your password, and understand where your credits and search history live.
- [Understanding SphereScout credits and usage](https://docs.spherescout.io/concepts/credits.md): Credits are the currency you spend to export contacts from SphereScout. Learn how credits work, when they reset, and what to do when you run out.
- [What's included in a SphereScout contact record](https://docs.spherescout.io/concepts/contacts.md): SphereScout contacts include name, email, phone, location, website, and social profiles. Learn what each field contains and how data accuracy is maintained.
- [Search filters in SphereScout explained](https://docs.spherescout.io/concepts/filters.md): Narrow 50M+ contacts by category, location, and presence filters in SphereScout. Learn how each filter works, how they combine, and tips for efficient searches.
- [Search SphereScout's business contact database](https://docs.spherescout.io/guides/searching.md): Learn how to use SphereScout's filters to find the exact business contacts you need — by category, location, and contact detail availability.
- [Export business contacts to CSV from SphereScout](https://docs.spherescout.io/guides/exporting.md): How to download your search results as a CSV file, what columns are included, how credits are charged, and how long your download link stays active.
- [Manage past exports in your SphereScout history](https://docs.spherescout.io/guides/export-history.md): Find, re-download, rename, and review all your past SphereScout exports from the History page, including file versions and expiry dates.
- [Get updated contacts with SphereScout data freshness](https://docs.spherescout.io/guides/data-freshness.md): Use SphereScout's data freshness feature to check for new contacts since your last export and download only the additions as a delta file, saving credits.
- [SphereScout subscription plans and pricing](https://docs.spherescout.io/billing/plans.md): Compare Starter, Growth, Pro, and Scale monthly plans. Understand how credits work, how to sign up, and when to choose a subscription over a one-time purchase.
- [Buy business contacts without a subscription](https://docs.spherescout.io/billing/one-time-purchase.md): Buy a specific set of business contacts with a single payment and no subscription. Select a category and location, get a price quote, then download your CSV.
- [Manage your SphereScout plan and billing](https://docs.spherescout.io/billing/managing-subscription.md): View your plan and credit balance, upgrade or downgrade, buy credit top-ups, manage payment methods, and review billing history from the Plans dashboard.
- [SphereScout REST API overview](https://docs.spherescout.io/api-access/overview.md): Explore SphereScout's REST API for programmatic access to the contact database: search, filter, and export business contacts at scale.
- [Create and manage SphereScout API keys](https://docs.spherescout.io/api-access/api-keys.md): Generate long-lived API keys in the SphereScout Dashboard or via the API, then use them to authenticate programmatic requests to the contact database.
- [Authenticate requests to the SphereScout API](https://docs.spherescout.io/api-access/authentication.md): Learn both authentication methods for the SphereScout API: long-lived API keys for integrations and JWT bearer tokens for user-session-based applications.
- [Frequently asked questions about SphereScout](https://docs.spherescout.io/faq.md): Answers to the most common questions about SphereScout credits, data quality, exports, billing, and API access for B2B contact database users.
- [Troubleshoot common SphereScout issues](https://docs.spherescout.io/troubleshooting.md): Step-by-step solutions for login problems, missing credits, failed exports, CSV issues, data freshness errors, and API authentication failures in SphereScout.
- [Post apiauthlogout](https://docs.spherescout.io/api-reference/authentication/post-apiauthlogout.md): Logs out the current user
- [Post apiauthrequest password reset](https://docs.spherescout.io/api-reference/authentication/post-apiauthrequest-password-reset.md): Send password reset link to email address
- [Post apiauthreset password](https://docs.spherescout.io/api-reference/authentication/post-apiauthreset-password.md): Reset password using the token received via email. Returns new JWT tokens on success.
- [Post apiauthsign up](https://docs.spherescout.io/api-reference/authentication/post-apiauthsign-up.md): Register a new user account
- [Post apitokenrefresh](https://docs.spherescout.io/api-reference/authentication/post-apitokenrefresh.md): Refresh access token using refresh token
- [Post apiauthmagic](https://docs.spherescout.io/api-reference/auth/post-apiauthmagic.md)
- [Get apicategories](https://docs.spherescout.io/api-reference/search/get-apicategories.md): List or search available business categories (e.g. Restaurant, Bakery, Plumber).
- [Get apicompanies](https://docs.spherescout.io/api-reference/search/get-apicompanies.md): Search for business leads matching the given filters and return a preview.
- [Get apicities ](https://docs.spherescout.io/api-reference/geography/get-apicities-.md): Get a list of Level 3 Locations (Cities) that have associated companies.
- [Get apilocationscountries](https://docs.spherescout.io/api-reference/geography/get-apilocationscountries.md): Get a list of countries that have companies
- [Post apicompanies reveal contact](https://docs.spherescout.io/api-reference/companies/post-apicompanies-reveal-contact.md)
- [Get apidownload completed csv ](https://docs.spherescout.io/api-reference/download/get-apidownload-completed-csv-.md): Get a signed download URL for a completed lead export.
- [Get apidownload csv](https://docs.spherescout.io/api-reference/download/get-apidownload-csv.md): Initiate an asynchronous lead export.
- [Post apidownload csv](https://docs.spherescout.io/api-reference/download/post-apidownload-csv.md): Initiate an asynchronous lead export.
- [Get apidownload status ](https://docs.spherescout.io/api-reference/download/get-apidownload-status-.md): Poll the processing status of a lead export.
- [Get apilocationslevel1](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel1.md): ViewSet for Level1 locations (states/regions) with filtering support.
- [Get apilocationslevel1 ](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel1-.md): ViewSet for Level1 locations (states/regions) with filtering support.
- [Get apilocationslevel2](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel2.md): ViewSet for Level2 locations (counties/departments) with filtering support.
- [Get apilocationslevel2 ](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel2-.md): ViewSet for Level2 locations (counties/departments) with filtering support.
- [Get apilocationslevel3](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel3.md): ViewSet for Level3 locations (cities) with filtering support.
- [Get apilocationslevel3 ](https://docs.spherescout.io/api-reference/locations/get-apilocationslevel3-.md): ViewSet for Level3 locations (cities) with filtering support.
- [Get apilocationssearch](https://docs.spherescout.io/api-reference/locations/get-apilocationssearch.md)
- [Get apipage snapshots ](https://docs.spherescout.io/api-reference/page-snapshots/get-apipage-snapshots-.md): Return the full country page-data payload from DB snapshots.
- [Get apiplans](https://docs.spherescout.io/api-reference/credits-&-profile/get-apiplans.md): List all active subscription plans with pricing and credit allowances.
- [Get apiuserprofile](https://docs.spherescout.io/api-reference/credits-&-profile/get-apiuserprofile.md): Get the authenticated user's profile, including remaining credits, subscription plan, and billing period dates.
- [Patch apiuserprofile](https://docs.spherescout.io/api-reference/credits-&-profile/patch-apiuserprofile.md): Get the authenticated user's profile, including remaining credits, subscription plan, and billing period dates.
- [Post apitoken|apiauthlogin](https://docs.spherescout.io/api-reference/token/post-apitoken|apiauthlogin.md): Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
- [List and create API keys](https://docs.spherescout.io/api-reference/api-keys/list-and-create-api-keys.md)
- [List and create API keys](https://docs.spherescout.io/api-reference/api-keys/list-and-create-api-keys-1.md)
- [Revoke an API key](https://docs.spherescout.io/api-reference/api-keys/revoke-an-api-key.md)
- [Get apiusersearch history](https://docs.spherescout.io/api-reference/history/get-apiusersearch-history.md): List all past lead searches for the authenticated user.
- [Post apiusersearch history download delta](https://docs.spherescout.io/api-reference/history/post-apiusersearch-history-download-delta.md): Start a fresh-data export for a previous search. Uncapped searches export only companies created after the original export. Capped searches create a full-expansion export and charge current total credits minus the original capped credits.
- [Post apiusersearch history freshness](https://docs.spherescout.io/api-reference/history/post-apiusersearch-history-freshness.md): Check and cache fresh data availability for a previous search.
- [Patch apiusersearch history rename](https://docs.spherescout.io/api-reference/history/patch-apiusersearch-history-rename.md): Rename a saved search history export.
- [Post apiusersearch history retry](https://docs.spherescout.io/api-reference/user/post-apiusersearch-history-retry.md)

## OpenAPI Specs

- [openapi](https://docs.spherescout.io/api-reference/openapi.json)