Search for business leads matching the given filters and return a preview.
Prerequisites: Authenticated with a valid JWT.
The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"SphereScout","colors":{"primary":"#4F46E5","light":"#EEF2FF","dark":"#1E1B4B"},"navbar":{"primary":{"type":"github","href":"https://github.com/raphaelcan/spherescout.io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spherescoutpteltd","hasAudioNarration":false,"actualSubdomain":"spherescoutpteltd","customDomains":["docs.spherescout.io"],"gitSource":{"type":"github","owner":"raphaelcan","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0da31e74a047ddf86ccf9","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"locations","count":7},{"language":"default","tag":"Authentication","count":5},{"language":"default","tag":"Using SphereScout","count":4},{"language":"default","tag":"Download","count":4},{"language":"default","tag":"History","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"API Access","count":3},{"language":"default","tag":"Plans \u0026 Billing","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@spherescout.io","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/search/get-apicompanies","slug":"/api-reference/search/get-apicompanies","pageMetadata":{"title":"Get apicompanies","description":"Search for business leads matching the given filters and return a preview.\n\n**Prerequisites:** Authenticated with a valid JWT.\n\nThe response includes `totalCount` which tells you how many credits an export will cost. Use this endpoint to refine filters before calling `/api/download-csv/`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/companies/","href":"/api-reference/search/get-apicompanies","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Search for business leads matching the given filters and return a preview.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Prerequisites:\"\n }), \" Authenticated with a valid JWT.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response includes \", _jsx(_components.code, {\n children: \"totalCount\"\n }), \" which tells you how many credits an export will cost. Use this endpoint to refine filters before calling \", _jsx(_components.code, {\n children: \"/api/download-csv/\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get apicompanies","description":"Search for business leads matching the given filters and return a preview.\n\n**Prerequisites:** Authenticated with a valid JWT.\n\nThe response includes `totalCount` which tells you how many credits an export will cost. Use this endpoint to refine filters before calling `/api/download-csv/`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/companies/","href":"/api-reference/search/get-apicompanies","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"companies_retrieve","description":"Search for business leads matching the given filters and return a preview.\n\n**Prerequisites:** Authenticated with a valid JWT.\n\nThe response includes `totalCount` which tells you how many credits an export will cost. Use this endpoint to refine filters before calling `/api/download-csv/`.","parameters":["a7b67c6d-9999-4daa-b8c4-210b723bae3a","78f1b944-6115-4198-885c-231ea9e0a43f","ecd689d1-b0e7-4afc-ab04-8fc9d0ba44b6","9ccde51a-7694-4814-a4c4-83ef67fc6d4a"],"tags":["Search"],"security":["29f1cf30-38e4-41d5-adfe-b5e15849b27e"],"responses":{"200":"6d5002c4-ab23-4460-8013-6342ca335bc5"},"x-llm-hint":"Step 1: Search. Use totalCount to estimate credits needed before exporting.","x-codeSamples":[{"lang":"cURL","source":"curl -X GET 'https://www.spherescout.io/api/companies/' \\\n -H 'Authorization: Token YOUR_API_KEY' \\\n -H 'User-Agent: SphereScout/1.0'"},{"lang":"Python","source":"import requests\n\nresponse = requests.get(\n \"https://www.spherescout.io/api/companies/\",\n headers={\n \"Authorization\": \"Token YOUR_API_KEY\",\n \"User-Agent\": \"SphereScout/1.0\",\n },\n)\nprint(response.json())"},{"lang":"JavaScript","source":"const response = await fetch(\"https://www.spherescout.io/api/companies/\", {\n headers: {\n \"Authorization\": \"Token YOUR_API_KEY\",\n \"User-Agent\": \"SphereScout/1.0\",\n },\n});\nconst data = await response.json();"}],"method":"get","type":"path","servers":["9cc753c8-0f3f-4652-8278-53dc7717776c"],"path":"/api/companies/","baseUrlOptions":["https://www.spherescout.io"],"title":"","codeSamples":[{"lang":"cURL","source":"curl -X GET 'https://www.spherescout.io/api/companies/' \\\n -H 'Authorization: Token YOUR_API_KEY' \\\n -H 'User-Agent: SphereScout/1.0'"},{"lang":"Python","source":"import requests\n\nresponse = requests.get(\n \"https://www.spherescout.io/api/companies/\",\n headers={\n \"Authorization\": \"Token YOUR_API_KEY\",\n \"User-Agent\": \"SphereScout/1.0\",\n },\n)\nprint(response.json())"},{"lang":"JavaScript","source":"const response = await fetch(\"https://www.spherescout.io/api/companies/\", {\n headers: {\n \"Authorization\": \"Token YOUR_API_KEY\",\n \"User-Agent\": \"SphereScout/1.0\",\n },\n});\nconst data = await response.json();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"a7b67c6d-9999-4daa-b8c4-210b723bae3a":{"in":"query","name":"category","schema":{"type":"integer","description":"Filter by category ID (from GET /api/categories/).","uniqueKey":"","typeLabel":"integer"},"description":"Filter by category ID (from GET /api/categories/)."},"78f1b944-6115-4198-885c-231ea9e0a43f":{"in":"query","name":"countries","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"description":"Filter by country alpha-2 codes (e.g. 'FR', 'AU'). Repeat for multiple.","uniqueKey":"","typeLabel":"string[]"},"description":"Filter by country alpha-2 codes (e.g. 'FR', 'AU'). Repeat for multiple."},"ecd689d1-b0e7-4afc-ab04-8fc9d0ba44b6":{"in":"query","name":"include_closed_businesses","schema":{"type":"boolean","enum":[false,true],"description":"Set to 'true' to include permanently closed businesses in the preview count. Defaults to 'false'.","uniqueKey":"","typeLabel":"enum\u003cboolean>"},"description":"Set to 'true' to include permanently closed businesses in the preview count. Defaults to 'false'."},"9ccde51a-7694-4814-a4c4-83ef67fc6d4a":{"in":"query","name":"level2_locations","schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"description":"Filter by level-2 location codes (states/departments).","uniqueKey":"","typeLabel":"string[]"},"description":"Filter by level-2 location codes (states/departments)."}},"responses":{"6d5002c4-ab23-4460-8013-6342ca335bc5":{"content":{"application/json":{"schema":{"type":"object","properties":{"preview":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique company identifier.","isRequired":true,"uniqueKey":"preview.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","description":"Business name.","isRequired":true,"uniqueKey":"preview.items.[INDEX].name","typeLabel":"string"},"email":{"type":"array","items":{"type":"string","uniqueKey":"preview.items.[INDEX].email.items.[INDEX]","typeLabel":"string"},"description":"List of email addresses.","isRequired":true,"uniqueKey":"preview.items.[INDEX].email","typeLabel":"string[]"},"phone":{"type":"string","description":"Primary phone number.","isRequired":true,"uniqueKey":"preview.items.[INDEX].phone","typeLabel":"string"},"city":{"type":"string","description":"City where the business is located.","isRequired":true,"uniqueKey":"preview.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","description":"Country name.","isRequired":true,"uniqueKey":"preview.items.[INDEX].country","typeLabel":"string"},"level2_location":{"type":"string","description":"State, region, or department name.","isRequired":true,"uniqueKey":"preview.items.[INDEX].level2_location","typeLabel":"string"}},"required":["city","country","email","id","level2_location","name","phone"],"uniqueKey":"preview.items.[INDEX]","typeLabel":"object"},"description":"Paginated list of matching companies (preview only, no full contact data).","isRequired":true,"uniqueKey":"preview","typeLabel":"object[]"},"totalCount":{"type":"integer","description":"Total number of leads matching the filters. Use this to estimate credit cost before exporting.","isRequired":true,"uniqueKey":"totalCount","typeLabel":"integer"},"cities":{"type":"array","items":{"type":"string","uniqueKey":"cities.items.[INDEX]","typeLabel":"string"},"description":"Distinct cities in the result set.","uniqueKey":"cities","typeLabel":"string[]"},"zipCodes":{"type":"array","items":{"type":"string","uniqueKey":"zipCodes.items.[INDEX]","typeLabel":"string"},"description":"Distinct zip/postal codes in the result set.","uniqueKey":"zipCodes","typeLabel":"string[]"},"categories":{"type":"array","items":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"categories.items.[INDEX].items.[INDEX]","typeLabel":"any"},"uniqueKey":"categories.items.[INDEX]","typeLabel":"any[]"},"description":"Categories represented in the result set.","uniqueKey":"categories","typeLabel":"any[][]"}},"required":["preview","totalCount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"preview":[{"id":123,"name":"\u003cstring>","email":["\u003cstring>"],"phone":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","level2_location":"\u003cstring>"}],"totalCount":123,"cities":["\u003cstring>"],"zipCodes":["\u003cstring>"],"categories":[["\u003cunknown>"]]}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"29f1cf30-38e4-41d5-adfe-b5e15849b27e":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key. Format: Token \u003cyour-api-key>","scopes":[]}}},"servers":{"9cc753c8-0f3f-4652-8278-53dc7717776c":{"url":"https://www.spherescout.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API key. Format: Token \u003cyour-api-key>","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API key. Format: Token \u003cyour-api-key>","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"spherescoutpteltd","siteName":"SphereScout","title":"Get apicompanies - SphereScout","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-11T15:47:33.779Z","originalFileLocation":"api-reference/search/get-apicompanies.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search for business leads matching the given filters and return a preview. Prerequisites: Authenticated with a valid JWT. The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SphereScout\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/spherescoutpteltd/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/spherescoutpteltd/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/spherescoutpteltd/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/spherescoutpteltd/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get apicompanies - SphereScout\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search for business leads matching the given filters and return a preview. Prerequisites: Authenticated with a valid JWT. The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SphereScout\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spherescout.io/api-reference/search/get-apicompanies\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spherescoutpteltd.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Get+apicompanies\u0026amp;description=Search+for+business+leads+matching+the+given+filters+and+return+a+preview.%0A%0A**Prerequisites%3A**+Authenticated+with+a+valid+JWT.%0A%0AThe+response+includes+%60totalCoun\u0026amp;theme=63fa2d938c50cead2be334ad\u0026amp;signature=5bf80df5d31fa89ffeca1954b2de65b7aadd57d0697df980c2c5b9472a21616b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get apicompanies - SphereScout\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search for business leads matching the given filters and return a preview. Prerequisites: Authenticated with a valid JWT. The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spherescoutpteltd.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Get+apicompanies\u0026amp;description=Search+for+business+leads+matching+the+given+filters+and+return+a+preview.%0A%0A**Prerequisites%3A**+Authenticated+with+a+valid+JWT.%0A%0AThe+response+includes+%60totalCoun\u0026amp;theme=63fa2d938c50cead2be334ad\u0026amp;signature=5bf80df5d31fa89ffeca1954b2de65b7aadd57d0697df980c2c5b9472a21616b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/spherescoutpteltd/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SphereScout\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spherescout.io/api-reference/search/get-apicompanies\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/search/get-apicompanies.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spherescout.io/#organization\",\"name\":\"SphereScout\",\"url\":\"https://docs.spherescout.io\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spherescout.io#website\",\"name\":\"SphereScout\",\"url\":\"https://docs.spherescout.io\",\"publisher\":{\"@id\":\"https://docs.spherescout.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies#webpage\",\"url\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies\",\"name\":\"Get apicompanies\",\"description\":\"Search for business leads matching the given filters and return a preview. Prerequisites: Authenticated with a valid JWT. The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.\",\"dateModified\":\"2026-08-11T15:47:33.779Z\",\"isPartOf\":{\"@id\":\"https://docs.spherescout.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search\",\"item\":\"https://docs.spherescout.io/api-reference/search/get-apicategories\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get apicompanies\",\"item\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies#apireference\",\"headline\":\"Get apicompanies\",\"name\":\"Get apicompanies\",\"description\":\"Search for business leads matching the given filters and return a preview. Prerequisites: Authenticated with a valid JWT. The response includes totalCount which tells you how many credits an export will cost. Use this endpoint to refine filters before calling /api/download-csv/.\",\"url\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spherescout.io/api-reference/search/get-apicompanies#webpage\"},\"dateModified\":\"2026-08-11T15:47:33.779Z\",\"publisher\":{\"@id\":\"https://docs.spherescout.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spherescout.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SphereScout\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SphereScout","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Post apiauthlogout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/auth/logout/","href":"/api-reference/authentication/post-apiauthlogout"},{"title":"Post apiauthrequest password reset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/auth/request-password-reset/","href":"/api-reference/authentication/post-apiauthrequest-password-reset"},{"title":"Post apiauthreset password","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/auth/reset-password/","href":"/api-reference/authentication/post-apiauthreset-password"},{"title":"Post apiauthsign up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/auth/sign-up/","href":"/api-reference/authentication/post-apiauthsign-up"},{"title":"Post apitokenrefresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/token/refresh/","href":"/api-reference/authentication/post-apitokenrefresh"}]},{"group":"auth","pages":[{"title":"Post apiauthmagic","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/auth/magic/","href":"/api-reference/auth/post-apiauthmagic"}]},{"group":"Search","pages":[{"title":"Get apicategories","description":"List or search available business categories (e.g. Restaurant, Bakery, Plumber).\n\nUse the returned `id` values as the `category` parameter in search endpoints. When `q` is provided, results include match metadata for agent disambiguation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/categories/","href":"/api-reference/search/get-apicategories"},{"title":"Get apicompanies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/companies/","href":"/api-reference/search/get-apicompanies"}]},{"group":"Geography","pages":[{"title":"Get apicities ","description":"Get a list of Level 3 Locations (Cities) that have associated companies.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/cities/{country_alpha2_code}/","href":"/api-reference/geography/get-apicities-"},{"title":"Get apilocationscountries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/countries/","href":"/api-reference/geography/get-apilocationscountries"}]},{"group":"companies","pages":[{"title":"Post apicompanies reveal contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/companies/{company_id}/reveal-contact/","href":"/api-reference/companies/post-apicompanies-reveal-contact"}]},{"group":"Download","pages":[{"title":"Get apidownload completed csv ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/download-completed-csv/{search_id}/","href":"/api-reference/download/get-apidownload-completed-csv-"},{"title":"Get apidownload csv","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/download-csv/","href":"/api-reference/download/get-apidownload-csv"},{"title":"Post apidownload csv","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/download-csv/","href":"/api-reference/download/post-apidownload-csv"},{"title":"Get apidownload status ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/download-status/{search_id}/","href":"/api-reference/download/get-apidownload-status-"}]},{"group":"locations","pages":[{"title":"Get apilocationslevel1","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level1/","href":"/api-reference/locations/get-apilocationslevel1"},{"title":"Get apilocationslevel1 ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level1/{id}/","href":"/api-reference/locations/get-apilocationslevel1-"},{"title":"Get apilocationslevel2","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level2/","href":"/api-reference/locations/get-apilocationslevel2"},{"title":"Get apilocationslevel2 ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level2/{id}/","href":"/api-reference/locations/get-apilocationslevel2-"},{"title":"Get apilocationslevel3","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level3/","href":"/api-reference/locations/get-apilocationslevel3"},{"title":"Get apilocationslevel3 ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/level3/{id}/","href":"/api-reference/locations/get-apilocationslevel3-"},{"title":"Get apilocationssearch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/locations/search/","href":"/api-reference/locations/get-apilocationssearch"}]},{"group":"page-snapshots","pages":[{"title":"Get apipage snapshots ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/page-snapshots/{alpha2}/","href":"/api-reference/page-snapshots/get-apipage-snapshots-"}]},{"group":"Credits \u0026 Profile","pages":[{"title":"Get apiplans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/plans","href":"/api-reference/credits-\u0026-profile/get-apiplans"},{"title":"Get apiuserprofile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/user/profile/","href":"/api-reference/credits-\u0026-profile/get-apiuserprofile"},{"title":"Patch apiuserprofile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/user/profile/","href":"/api-reference/credits-\u0026-profile/patch-apiuserprofile"}]},{"group":"token","pages":[{"title":"Post apitoken|apiauthlogin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/token/|api/auth/login/","href":"/api-reference/token/post-apitoken|apiauthlogin"}]},{"group":"API Keys","pages":[{"title":"List and create API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/user/api-keys/","href":"/api-reference/api-keys/list-and-create-api-keys"},{"title":"List and create API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/user/api-keys/","href":"/api-reference/api-keys/list-and-create-api-keys-1"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/user/api-keys/{key_id}/","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"History","pages":[{"title":"Get apiusersearch history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/user/search-history/","href":"/api-reference/history/get-apiusersearch-history"},{"title":"Post apiusersearch history download delta","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/user/search-history/{search_id}/download-delta/","href":"/api-reference/history/post-apiusersearch-history-download-delta"},{"title":"Post apiusersearch history freshness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/user/search-history/{search_id}/freshness/","href":"/api-reference/history/post-apiusersearch-history-freshness"},{"title":"Patch apiusersearch history rename","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/user/search-history/{search_id}/rename/","href":"/api-reference/history/patch-apiusersearch-history-rename"}]},{"group":"user","pages":[{"title":"Post apiusersearch history retry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/user/search-history/{search_id}/retry/","href":"/api-reference/user/post-apiusersearch-history-retry"}]}]}]},"basePath":"","title":"Get apicompanies - SphereScout","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C945cI-W.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}