ViviScape icon

ViviScape

Interact with ViviScape API

CRM → Query Prospects

AI-generated

Summary

Query prospects in the CRM by sending a search query string, filtering by user ID, and/or filtering by a comma-separated list of stages.

Inputs

  • Query — A search query string to find matching prospects.
  • User ID — A numeric user ID to filter prospects assigned to a specific user.
  • Stages — A comma-separated list of prospect stages to filter results by.

Output shape

a list of prospect records matching the query and filters

The operation sends a POST request with optional query parameters. Stages input is split by commas into an array for filtering. Returned data is an array of JSON objects representing prospects.

Discussion