CRM
Search opportunities
Search opportunities with optional pipeline scope, stage, structured filters, sort, cursor pagination, and field projection. pipeline_id is optional; when omitted the search spans every pipeline in the org. Custom attribute names and value types are returned in data.custom_field_definitions; keys in that map match keys under each opportunity's custom_fields object.
post/v1/opportunities/search
Request body
Example request
{
"filters": [
{
"field": "created_at",
"operator": "gt",
"value": "2024-06-11T01:40:00Z"
}
]
}Response
Opportunities were returned.
Example response
{
"success": true,
"data": {
"custom_field_definitions": {
"last_action_date": {
"current_name": "Last Action Date",
"property_name": "custom__last_action_date",
"attribute_type": "date",
"metadata": null
},
"kola": {
"current_name": "Kola",
"property_name": "custom__kola",
"attribute_type": "multi_select",
"metadata": {
"options": [
{
"label": "E",
"value": "e-532837",
"color": "indigo"
}
]
}
}
}
}
}