CRM
List opportunities
Returns opportunities in a required pipeline using cursor pagination with optional stage, search, and field projection. 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.
get/v1/opportunities
Query parameters
pipeline_idstring required
Pipeline ID. Required for opportunity reads.
stage_idstring
Optional stage ID.
qstring
Free-text search query.
cursorstring
Opaque pagination cursor returned by a previous page.
limitinteger
Maximum number of records.
Optional fields to include. Accepts a comma-separated string or repeated array values.
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"
}
]
}
}
}
}
}