latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-11127314911.9 KB

36dd0c57cea7

V2Prospects

Fetch Prospects

post/v2/prospects

Request body

request_contextobject 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_sizeinteger required

The maximum number of prospects in a page.

excludestring[] nullable
next_cursorstring nullable

Cursor returned by the previous page. Omit or send null to start from the beginning.

Example request

{
  "page_size": 3,
  "filters": {}
}

Response

Successful Response

total_resultsinteger

The total number of prospects that match the filters.