---
title: "Fetch Prospects"
method: POST
path: "/v2/prospects"
tags: ["V2Prospects"]
---

# Fetch Prospects

`POST /v2/prospects`

## Request body

- V2ProspectsFetchRequest
  - `request_context` object, nullable
  - `mode` 'full' | 'preview', required — The `BaseFetchMode` class is an enumeration that defines the modes for fetching data. This enum is used to specify whether the fetch operation should retrieve the full data or just a preview of the data. It ensures consistent handling of fetch modes across the application. Attributes: FULL: Fetch the complete data. PREVIEW: Fetch a preview or partial data.
  - `page_size` integer, required — The maximum number of prospects in a page.
  - `exclude` string[], nullable
  - `filters` V2ProspectsFetchFilters
    - `prospect_id` IncludesFilterProspectId
      - `negate` boolean
      - `values` string[], required
    - `has_contact_details` ContactDetailsFilter
      - `value` 'email' | 'phone' | 'email_or_phone' | 'email_and_phone', required — An enumeration.
      - `negate` boolean
    - `job_level` IncludesFilterJobSeniorityLevel
      - `negate` boolean
      - `values` JobSeniorityLevel[], required
    - `job_department` IncludesFilterJobDepartment
      - `negate` boolean
      - `values` JobDepartment[], required
    - `business_id` IncludesFilterBusinessId
      - `negate` boolean
      - `values` string[], required
    - `total_experience_months` RangeFilterInt
      - `negate` boolean
      - `gte` integer
      - `lte` integer
    - `country_code` IncludesFilterCountryCodeAlpha2
      - `negate` boolean
      - `values` string[], required
    - `region_country_code` IncludesFilterRegionCode
      - `negate` boolean
      - `values` string[], required
    - `current_role_months` RangeFilterInt
      - `negate` boolean
      - `gte` integer
      - `lte` integer
    - `company_size` IncludesFilterNumberOfEmployeesRange
      - `negate` boolean
      - `values` NumberOfEmployeesRange[], required
    - `company_revenue` IncludesFilterRevenueRange
      - `negate` boolean
      - `values` RevenueRange[], required
    - `company_age` IncludesFilterCompanyAgeRange
      - `negate` boolean
      - `values` CompanyAgeRange[], required
    - `company_number_of_locations` IncludesFilterNumberOfLocations
      - `negate` boolean
      - `values` NumberOfLocations[], required
    - `google_category` IncludesFilterStandardizedText
      - `negate` boolean
      - `values` string[], required
    - `naics_category` IncludesFilterNAICS
      - `negate` boolean
      - `values` string[], required
    - `linkedin_category` IncludesFilterText
      - `negate` boolean
      - `values` string[], required
    - `job_title` JobTitleFilter
      - `negate` boolean
      - `values` string[], required — List of job titles to filter by. Maximum 300 items allowed.
      - `operator` 'or' | 'and'
      - `include_related_job_titles` boolean, nullable — When set to true, includes related job titles in the search.
    - `skills` AnyMatchPhraseFilterText
      - `negate` boolean
      - `values` string[], required
      - `operator` 'or' | 'and'
    - `interests` AnyMatchPhraseFilterText
      - `negate` boolean
      - `values` string[], required
      - `operator` 'or' | 'and'
    - `company_country_code` IncludesFilterCountryCodeAlpha2
      - `negate` boolean
      - `values` string[], required
    - `company_region_country_code` IncludesFilterRegionCode
      - `negate` boolean
      - `values` string[], required
    - `city_region_country` IncludesFilterText
      - `negate` boolean
      - `values` string[], required
    - `company_name` AnyMatchFilterOrganizationName
      - `negate` boolean
      - `values` string[], required
    - `has_website` ExistsFilter
      - `negate` boolean
      - `value` boolean, required
    - `is_public_company` ExistsFilter
      - `negate` boolean
      - `value` boolean, required
  - `next_cursor` string, nullable — Cursor returned by the previous page. Omit or send null to start from the beginning.

## Response `200`

Successful Response

- ProspectsFetchResponseV2 — This is base response model for all responses in partner service.
  - `response_context` ResponseContext, required
    - `correlation_id` string, required
    - `request_status` 'success' | 'miss' | 'failure', required — The `RequestStatus` class is an enumeration that defines the possible statuses of a request. This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application. Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.
    - `time_took_in_seconds` number, required
  - `data` Prospect[] — List of prospects that match the filters.
    - `prospect_id` string
    - `professional_email_hashed` string
    - `first_name` string
    - `last_name` string
    - `full_name` string
    - `country_name` string
    - `region_name` string
    - `city` string
    - `linkedin` string
    - `experience` string[]
    - `skills` string[]
    - `interests` string[]
    - `company_name` string
    - `company_website` string
    - `company_linkedin` string
    - `job_department` string
    - `job_department_array` string[]
    - `job_department_main` string
    - `job_seniority_level` string[]
    - `job_level_array` string[]
    - `job_level_main` string
    - `job_title` string
    - `business_id` string
    - `linkedin_url_array` string[]
  - `total_results` integer — The total number of prospects that match the filters.
  - `page` PartnerServiceModelsProspectsRequestsPageInfo, required
    - `size` integer, required — Number of results in this page
    - `next_cursor` string — Cursor for pagination. Use this value as cursor in the next request.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/explorium-ai/apis/partner-service.md) · [All operations](https://skmtc.net/explorium-ai/apis/partner-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/explorium-ai/partner-service/revisions/36dd0c57cea7/schema)