v1
latestOpenAPI 3.1.02026-07-135055368.9 KBProspects
List All Prospects
List All Prospects
get/v1/prospects
Query parameters
search_bystring nullable
Field name to search by
Field name to search by
search_valuestring nullable
Value to search for in the specified field
Value to search for in the specified field
statusstring nullable
Filter by status
Filter by status
sort_bystring nullable
Field to sort by
Field to sort by
sort_order'asc' | 'desc'
Sort order (asc or desc)
skipinteger
Number of records to skip
Number of records to skip
limitinteger
Maximum number of records to return
Maximum number of records to return
Response
List of prospects retrieved successfully
Example response
[
{
"externalReference": [
{
"providerName": "Google Analytics",
"id": "GA-123456"
}
]
}
]