Skip to main content
POST
/
v1
/
prospects
/
search
Search Prospects
curl --request POST \
  --url https://api.example.com/v1/prospects/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "person_titles": [
      {}
    ],
    "person_locations": [
      {}
    ],
    "organization_industries": [
      {}
    ],
    "organization_num_employees_ranges": [
      {}
    ]
  },
  "page": 123,
  "per_page": 123
}
'
{
  "data": {
    "prospects": [
      {
        "id": "<string>",
        "name": "<string>",
        "title": "<string>",
        "email": "<string>",
        "company": "<string>",
        "location": "<string>",
        "linkedin_url": "<string>"
      }
    ]
  },
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Request

Headers

Authorization: Bearer wbk_your_api_key_here
Content-Type: application/json

Body Parameters

query
object
required
Search query object with filters
page
integer
default:"1"
Page number for pagination
per_page
integer
default:"25"
Results per page (max: 100)

Response

data
object
meta
object
Pagination metadata
curl -X POST \
  https://nbkxaqxwvkgbddekwsma.supabase.co/functions/v1/api-gateway/v1/prospects/search \
  -H "Authorization: Bearer wbk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "query": {
      "person_titles": ["CEO", "Chief Executive Officer"],
      "organization_industries": ["Legal"],
      "person_locations": ["United States"],
      "organization_num_employees_ranges": ["11-50", "51-200"]
    },
    "per_page": 50
  }'

Example Response

{
  "data": {
    "prospects": [
      {
        "id": "apollo_123456",
        "name": "John Smith",
        "title": "CEO",
        "email": "john@example.com",
        "company": "Acme Legal Corp",
        "location": "New York, NY",
        "linkedin_url": "https://linkedin.com/in/johnsmith"
      },
      {
        "id": "apollo_789012",
        "name": "Jane Doe",
        "title": "Chief Executive Officer",
        "email": "jane@lawfirm.com",
        "company": "Legal Partners LLC",
        "location": "San Francisco, CA",
        "linkedin_url": "https://linkedin.com/in/janedoe"
      }
    ]
  },
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 150
  }
}

Query Examples

Search by Multiple Job Titles

{
  "query": {
    "person_titles": ["CTO", "VP of Engineering", "Director of Technology"]
  }
}

Search by Location and Industry

{
  "query": {
    "person_locations": ["California", "Texas"],
    "organization_industries": ["Technology", "SaaS"]
  }
}

Search by Company Size

{
  "query": {
    "organization_num_employees_ranges": ["51-200", "201-500"]
  }
}

Notes

Prospect search results come from a third-party data provider. Email addresses may not always be available.
After finding prospects, use the Save Prospects endpoint to add them to your CRM.

Errors

StatusCodeDescription
400validation_errorMissing or invalid query parameters
401invalid_keyInvalid API key
403insufficient_permissionsMissing read permission
429rate_limitedRate limit exceeded