> ## Documentation Index > Fetch the complete documentation index at: https://docs.sendora.ai/llms.txt > Use this file to discover all available pages before exploring further. # Preview prospect search results > Preview prospect search results. See the request and response schemas for the complete public API contract. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout. ## OpenAPI ````yaml /openapi.json post /api/v1/public/lead-lists/{list_id}/prospect-search/preview openapi: 3.1.0 info: description: >- Customer-facing API for managing outreach, leads, conversations, voice agents, knowledge bases, analytics, and webhooks. title: Sendora Public API version: 1.0.0 servers: - description: Production url: https://api.sendora.ai security: [] tags: - description: Build, launch, pause and stop campaigns, and enroll leads. name: Campaigns - description: Create, update, tag, enrich and import leads. name: Leads - description: Group leads into reusable lists. name: Lead lists - description: Find new prospects and research existing leads. name: Prospecting - description: Read conversations and send messages to leads. name: Inbox - description: Manage workspace-wide suppressions. name: Do not contact - description: Manage the content your agents answer from. name: Knowledge bases - description: Create, configure, test and publish voice agents. name: Voice agents - description: Give agents actions such as booking, lookups and transfers. name: Agent tools - description: Embed a voice agent on your website. name: Voice widgets - description: Start voice calls and read call results. name: Calls - description: Browse and preview the voices an agent can use. name: Voices - description: List numbers, bring your own, and route calls. name: Phone numbers - description: List the channel accounts connected to the workspace. name: Connected accounts - description: Register endpoints and review deliveries. name: Webhooks - description: Drive the workspace assistant programmatically. name: Copilot - description: Read workspace and campaign performance. name: Analytics - description: Track asynchronous operations. name: Jobs - description: Manage client workspaces, plans and branding. name: Agency paths: /api/v1/public/lead-lists/{list_id}/prospect-search/preview: post: tags: - Prospecting summary: Preview prospect search results description: >- Preview prospect search results. See the request and response schemas for the complete public API contract. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout. operationId: public_create_prospect_search_preview parameters: - description: >- The lead list's id: the `id` from List lead lists. It is also the last part of that page's address in the app. in: path name: list_id required: true schema: title: List Id type: string - in: header name: X-API-Key required: false schema: anyOf: - type: string - type: 'null' title: X-Api-Key - in: header name: Authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization requestBody: content: application/json: schema: $ref: >- #/components/schemas/api__v1__leads__routes__prospect_search_preview__PreviewCreate required: true responses: '201': content: application/json: schema: $ref: >- #/components/schemas/api__v1__leads__routes__prospect_search_preview__PreviewOut description: Successful Response '401': description: The X-API-Key header is missing, invalid, expired, or revoked. '402': description: >- The workspace is suspended for billing, or the request would exceed a plan or usage limit. '403': description: >- The key is valid but lacks the required scope, or the workspace has no active plan, lacks the entitlement, or has this feature turned off or view-only. '404': description: >- The resource does not exist or is not owned by the authenticated workspace. '410': description: The workspace behind this key has been deleted. '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error '500': description: >- An unexpected Sendora error occurred. Retry only if the operation is safe to repeat. '503': description: >- An entitlement or billing check is temporarily unavailable. Retry after the Retry-After interval. security: - ApiKeyAuth: [] x-codeSamples: - label: cURL lang: bash source: >- curl -X POST 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \ -d '{"filters":{"analytics_tech":["example"],"city":"example","company_name":"example"}}' - label: Python lang: python source: >- import requests url = 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview' headers = {'X-API-Key': '$SENDORA_API_KEY'} response = requests.post(url, headers=headers, json={'filters': {'analytics_tech': ['example'], 'city': 'example', 'company_name': 'example'}}) response.raise_for_status() print(response.json()) - label: JavaScript lang: javascript source: >- const response = await fetch("https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", { method: "POST", headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' }, body: JSON.stringify({"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}), }); if (!response.ok) throw new Error(await response.text()); console.log(await response.json()); - label: Go lang: go source: >- req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview", bytes.NewBufferString(`{"filters": {"analytics_tech": ["example"], "city": "example", "company_name": "example"}}`)) if err != nil { log.Fatal(err) } req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY")) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { log.Fatal(err) } defer resp.Body.Close() components: schemas: api__v1__leads__routes__prospect_search_preview__PreviewCreate: properties: auto_enrich: default: true description: Auto enrich returned by the Sendora API. title: Auto Enrich type: boolean filters: $ref: '#/components/schemas/ProspectingFilters' description: Filters returned by the Sendora API. page: default: 1 description: Page returned by the Sendora API. minimum: 1 title: Page type: integer page_size: default: 100 description: Page size returned by the Sendora API. maximum: 100 minimum: 1 title: Page Size type: integer required: - filters title: PreviewCreate type: object api__v1__leads__routes__prospect_search_preview__PreviewOut: properties: error_message: anyOf: - type: string - type: 'null' description: Error message returned by the Sendora API. title: Error Message id: description: >- The preview's id. Pass it as `preview_id` to read or import this result set. format: uuid title: Id type: string results: description: Results returned by the Sendora API. items: additionalProperties: true type: object title: Results type: array status: description: Status returned by the Sendora API. title: Status type: string total_matches: anyOf: - type: integer - type: 'null' description: Total matches returned by the Sendora API. title: Total Matches required: - id - status - results title: PreviewOut type: object HTTPValidationError: properties: detail: description: Detail returned by the Sendora API. items: $ref: '#/components/schemas/ValidationError' title: Detail type: array required: [] title: HTTPValidationError type: object ProspectingFilters: properties: analytics_tech: description: Analytics tech returned by the Sendora API. items: type: string maxItems: 10 title: Analytics Tech type: array city: default: '' description: City returned by the Sendora API. maxLength: 100 title: City type: string company_name: default: '' description: Company name returned by the Sendora API. maxLength: 200 title: Company Name type: string company_name_mode: default: '' description: Company name mode returned by the Sendora API. maxLength: 10 title: Company Name Mode type: string country: description: Country returned by the Sendora API. items: type: string maxItems: 20 title: Country type: array crm_tech: description: Crm tech returned by the Sendora API. items: type: string maxItems: 10 title: Crm Tech type: array development_tech: description: Development tech returned by the Sendora API. items: type: string maxItems: 10 title: Development Tech type: array domain: default: '' description: Domain returned by the Sendora API. maxLength: 200 title: Domain type: string employee_count_max: anyOf: - minimum: 0 type: integer - type: 'null' description: Employee count max returned by the Sendora API. title: Employee Count Max employee_count_min: anyOf: - minimum: 0 type: integer - type: 'null' description: Employee count min returned by the Sendora API. title: Employee Count Min erp_tech: description: Erp tech returned by the Sendora API. items: type: string maxItems: 10 title: Erp Tech type: array founded_on: anyOf: - maximum: 2100 minimum: 1800 type: integer - type: 'null' description: Founded on returned by the Sendora API. title: Founded On funded_after: default: '' description: Funded after returned by the Sendora API. maxLength: 20 title: Funded After type: string funding_amount_min: anyOf: - minimum: 0 type: number - type: 'null' description: Funding amount min returned by the Sendora API. title: Funding Amount Min funding_types: description: Funding types returned by the Sendora API. items: type: string maxItems: 20 title: Funding Types type: array has_cio: anyOf: - type: boolean - type: 'null' description: Has cio returned by the Sendora API. title: Has Cio has_ciso: anyOf: - type: boolean - type: 'null' description: Has ciso returned by the Sendora API. title: Has Ciso has_mobile_app: anyOf: - type: boolean - type: 'null' description: Has mobile app returned by the Sendora API. title: Has Mobile App has_web_app: anyOf: - type: boolean - type: 'null' description: Has web app returned by the Sendora API. title: Has Web App headquarters_city: default: '' description: Headquarters city returned by the Sendora API. maxLength: 100 title: Headquarters City type: string headquarters_country: description: Headquarters country returned by the Sendora API. items: type: string maxItems: 20 title: Headquarters Country type: array headquarters_state: default: '' description: Headquarters state returned by the Sendora API. maxLength: 100 title: Headquarters State type: string hiring_departments: description: Hiring departments returned by the Sendora API. items: type: string maxItems: 12 title: Hiring Departments type: array industry: default: '' description: Industry returned by the Sendora API. maxLength: 200 title: Industry type: string is_linkedin_url_claimed: anyOf: - type: boolean - type: 'null' description: Is linkedin url claimed returned by the Sendora API. title: Is Linkedin Url Claimed job_function: description: Job function returned by the Sendora API. items: type: string maxItems: 26 title: Job Function type: array job_level: description: Job level returned by the Sendora API. items: type: string maxItems: 10 title: Job Level type: array job_title: description: Job title returned by the Sendora API. items: type: string maxItems: 25 title: Job Title type: array linkedin_industry: description: Linkedin industry returned by the Sendora API. items: type: string maxItems: 20 title: Linkedin Industry type: array marketing_automation_tech: description: Marketing automation tech returned by the Sendora API. items: type: string maxItems: 10 title: Marketing Automation Tech type: array min_linkedin_growth_rate: anyOf: - type: number - type: 'null' description: Min linkedin growth rate returned by the Sendora API. title: Min Linkedin Growth Rate min_monthly_web_traffic: anyOf: - minimum: 0 type: integer - type: 'null' description: Min monthly web traffic returned by the Sendora API. title: Min Monthly Web Traffic revenue_buckets: description: Revenue buckets returned by the Sendora API. items: type: string maxItems: 6 title: Revenue Buckets type: array revenue_max: anyOf: - minimum: 0 type: number - type: 'null' description: Revenue max returned by the Sendora API. title: Revenue Max revenue_min: anyOf: - minimum: 0 type: number - type: 'null' description: Revenue min returned by the Sendora API. title: Revenue Min sales_automation_tech: description: Sales automation tech returned by the Sendora API. items: type: string maxItems: 10 title: Sales Automation Tech type: array state: description: State returned by the Sendora API. items: type: string maxItems: 20 title: State type: array team_size_departments: description: Team size departments returned by the Sendora API. items: type: string maxItems: 15 title: Team Size Departments type: array required: [] title: prospectingFilters type: object ValidationError: properties: loc: description: Loc returned by the Sendora API. items: anyOf: - type: string - type: integer title: Location type: array msg: description: Msg returned by the Sendora API. title: Message type: string type: description: Type returned by the Sendora API. title: Error Type type: string required: - loc - msg - type title: ValidationError type: object securitySchemes: ApiKeyAuth: description: Customer API key created in the Sendora dashboard. in: header name: X-API-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.