Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Query Parameters

book_id
string

Filter by book ID

pipeline_type
enum<string>

Filter by pipeline type

Available options:
prospect,
client
pipeline_id
string

Filter by pipeline ID

pipeline_stage_id
string

Filter by pipeline stage ID

household_id
string

Filter by household ID

Response

opportunities filtered by household_id

data
object[]
required
pagination
object
required