Raw schema
{
"type": "object",
"properties": {
"name": {
"description": "Opportunity-name filter (substring match).",
"type": "string"
},
"assignee_ids": {
"description": "Filter to opportunities owned by these user ids.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"pipeline_ids": {
"description": "Filter to opportunities in these pipelines.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"pipeline_stage_ids": {
"description": "Filter to opportunities at these pipeline stages.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"company_ids": {
"description": "Filter to opportunities at these company ids.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"status_ids": {
"description": "Filter by status id: 0=Open, 1=Won, 2=Lost, 3=Abandoned.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"tags": {
"description": "Filter to opportunities carrying any of these tags.",
"type": "array",
"items": {
"type": "string"
}
},
"sort_by": {
"description": "Field to sort by, e.g. 'name', 'date_created', 'monetary_value' (default 'name').",
"type": "string"
},
"sort_direction": {
"description": "Sort direction โ 'asc' or 'desc' (default asc).",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page_number": {
"description": "1-based page number to fetch (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"page_size": {
"description": "Results per page (default 20, max 200).",
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}