Skip to main content
GET
List Opportunities

Authorizations

api_access_token
string
header
required

Path Parameters

account_id
integer
required

The numeric ID of the account

Query Parameters

stage
integer

Filter by stage

status
enum<string>

Filter by status

Available options:
active,
deleted
owner_id
integer

Filter by owner

company_id
integer

Filter by company

contact_id
integer

Filter by contact

opportunity_column_id
integer

Filter by opportunity column (kanban)

page
integer

Page number (default 1)

paginate
enum<string>

Set to false to fetch all matching rows (no pagination)

Available options:
false

Response

200 - application/json

Success

payload
object[]
meta
object