> ## Documentation Index
> Fetch the complete documentation index at: https://docs.optareach.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run one-time prospect search

> Queues a prospect search using one of the platform's search import methods. Get the allowed method IDs first from the prospect-import-methods endpoint. CSV and source-list methods use their dedicated endpoints.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/platforms/{platform}/prospect-lists/search
openapi: 3.1.0
info:
  title: Optareach Public API
  version: 1.0.0
  description: >-
    Platform-first API surface for accounts, prospects, campaigns, inbox,
    tracked searches, AI rooms, workspaces, analytics, billing, profile, and
    knowledge bases.
servers:
  - url: https://optareach.com
    description: Production
security: []
tags:
  - name: Meta
    description: API metadata and discovery
  - name: Platforms
    description: Platform registry and capabilities
  - name: Accounts
    description: Connected sender accounts
  - name: Prospects
    description: Prospect lists and leads
  - name: Campaigns
    description: Campaign lifecycle and performance
  - name: Inbox
    description: Conversations and messages
  - name: TrackedSearches
    description: Mentions and tracked search streams
  - name: AI
    description: AI chat rooms and enrichment
  - name: Workspaces
    description: Workspace management
  - name: KnowledgeBases
    description: Knowledge base management
  - name: Analytics
    description: Global dashboard metrics
  - name: Billing
    description: Subscriptions and credits
  - name: Profile
    description: Current user profile
  - name: Tags
    description: Conversation tags
paths:
  /api/v1/platforms/{platform}/prospect-lists/search:
    post:
      tags:
        - Prospects
      summary: Run one-time prospect search
      description: >-
        Queues a prospect search using one of the platform's search import
        methods. Get the allowed method IDs first from the
        prospect-import-methods endpoint. CSV and source-list methods use their
        dedicated endpoints.
      parameters:
        - $ref: '#/components/parameters/platform'
      requestBody:
        description: >-
          One-time search payload. importMethod must be a search-flow method
          returned for the selected platform.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProspectSearchWrite'
            example:
              importMethod: linkedin-search-bar
              title: B2B SaaS founders
              accountId: acct_linkedin_demo
              searchUrl: >-
                https://www.linkedin.com/search/results/people/?keywords=b2b%20saas%20founder
              credits: 40
      responses:
        '201':
          description: Prospect search queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/QueuedSearchResult'
                required:
                  - data
              examples:
                success:
                  summary: Example response
                  value:
                    data:
                      id: list_match_arsenal_chelsea
                      queued: true
components:
  parameters:
    platform:
      name: platform
      in: path
      required: true
      schema:
        type: string
  schemas:
    ProspectSearchWrite:
      type: object
      properties:
        importMethod:
          type: string
          description: >-
            Method ID returned by GET
            /platforms/{platform}/prospect-import-methods. import_method_id is
            also accepted.
        import_method_id:
          type: string
          description: Snake-case alias for importMethod.
        title:
          type: string
        accountId:
          type: string
        account_id:
          type: string
          description: Snake-case alias for accountId.
        accountIds:
          type: array
          items:
            type: string
        accounts:
          type: array
          items:
            type: string
        must_contain:
          type: string
          description: Search, profile, event, or collection URL for URL-based methods.
        searchUrl:
          type: string
          format: uri
          description: Camel-case alias for must_contain.
        post_url:
          type: string
          format: uri
        profile_url:
          type: string
          format: uri
        subreddit_url:
          type: string
          format: uri
        company_identifiers:
          type: array
          items:
            type: string
        profile_identifiers:
          type: array
          items:
            type: string
        action:
          type: string
        must_not_contain:
          type: string
        order:
          type: string
        sentiment:
          type: string
        return:
          type: string
        same_country:
          type: boolean
        locations:
          type: array
          items:
            type: string
        credits:
          type: integer
          minimum: 1
        schedule:
          type: object
          additionalProperties: true
      required:
        - importMethod
    QueuedSearchResult:
      type: object
      properties:
        id:
          type: string
        queued:
          type: boolean
      required:
        - id
        - queued

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.