v1
latestOpenAPI 3.0.12026-07-268028223.9 KBOpportunities
List opportunities
List all opportunities for a household
get/v1/households/{household_id}/opportunities
Query parameters
pageinteger
Page number
per_pageinteger
Items per page (1-100, default: 25). Values over 100 will be clamped to 100.
Response
successful
Example response
{
"data": [
{
"id": "abc123xyz",
"name": "New Investment Opportunity",
"value": 5000,
"probability": 75,
"book_id": "book123xyz",
"household_id": "household123xyz",
"pipeline": {
"id": "pipeline123xyz",
"name": "Sales Pipeline",
"pipeline_type": "prospect",
"book_id": "book123xyz",
"pipeline_stages": [
{
"id": "stage123xyz",
"name": "Qualified",
"stage_order": 1,
"visible": true,
"default_probability": 50
}
]
},
"pipeline_stage": {
"id": "stage123xyz",
"name": "Qualified",
"stage_order": 1,
"visible": true,
"default_probability": 50
},
"custom_fields": {
"lead_source": "Referral"
},
"assigned_to": {
"id": "abc123xyz",
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"api_access": {
"auth_type": "personal_access_token",
"scope": "read_write"
}
}
}
],
"pagination": {
"current_page": 1,
"total_pages": 10,
"total_count": 100,
"per_page": 25
}
}