Skip to navigation
Deal ManagementDeal

Advanced Search

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
filtersobject or nullOptional

Base filter model for deal search. Supports individual field filters or logical operators ($and, $or).

Example with benchmark metrics:

{
    "filters": {
        "$and": [
            {"company_name": "Acme"},
            {
                "benchmark_metrics": {
                    "field_name": "revenue",
                    "conditions": [
                        {"operator": "$gte", "value": 1000000},
                        {"operator": "$lte", "value": 5000000}
                    ]
                }
            }
        ]
    }
}
sortlist of objects or nullOptional

Optional list of sort criteria. Earlier items take precedence. Each item must specify ‘sort_by’ (SortField, BenchmarkMetricField, or DateField enum) and ‘sort_order’. ‘sort_by’ values must be unique.

pageintegerOptional>=1Defaults to 1
Page number
page_sizeintegerOptional1-1000Defaults to 100
Number of items per page

Response

Successful Response
total_countinteger
pageinteger
page_sizeinteger
datalist of objects

Errors

422
Unprocessable Entity Error