Sign in
Prospects

Fetch Prospects

post/v1/prospects

Headers

tenantstring

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.

sizeinteger required

The maximum number of prospects to return. Max size is 60000

page_sizeinteger required

The maximum number of prospects in a page. Max limit is 500

pageinteger nullable

The page number to fetch.

excludestring[] nullable

List of prospect ids to exclude from the response.

next_cursorstring nullable

The sort values from the last document returned by the previous page. If provided, cursor pagination is used instead of page-based pagination. send "null" to start with next_cursor pagination from the beginning.

Example request

{
  "size": 3,
  "page_size": 3,
  "page": 1,
  "filters": {}
}

Response

Successful Response

OR

Changes

No recorded changes to this endpoint across all 1 revision of this API.