Search Deals
Search for pipeline deals in the system
GET
/api/v1/pipeline/search
Path Parameters
search_term
String
Term to search by in the pipeline deals
search_by
String
Field to search by, defaults to all. Allowed fields: stage, user_id, primary_contact, company
current_page
Number
Current page of the request, allows for pagination
query_amount
Number
Amount of request to get, defaults 20, max is 100
exclude
String
stages to exclude from the search
Request
"/api/v1/pipeline/search?query_amount=1&search_term=example&search_by=company"
Response:
deals
Array
Contains the deals that are returned in the search
total_deals
Number
Total number of contacts matching the query
page
Number
Current page number (0-indexed)
per_page
String
Number of contacts returned per page
Response
{
"deals": [
{
"created_at": "2025-06-03T01:01:34.734899+00:00",
"user_id": "23456789012",
"deal_size": 25000,
"primary_contact": null,
"stage": "Qualification",
"open_date": "2025-05-01",
"close_date": null,
"owner": "Jane",
"company": "Example inc",
"id": "1234567890",
"notes": null,
"contact_email": null
}
],
"total_deals": 30,
"page": 0,
"per_page": 1
}