Skip to main content
GET
List Opportunities

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
Required range: x >= 1
per_page
integer | null
Required range: x >= 1
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
pipeline_id
string[] | null

Filter by one or more pipelines

current_stage_id
string[] | null

Filter by one or more current stages

campaign_id
string[] | null

Filter by one or more campaigns

assigned_provider_id
string[] | null

Filter by one or more assigned providers

status
enum<string>[] | null

Filter by one or more opportunity statuses

Terminal-capable status for a pursuit episode (separate from stage).

Schema column lands with the opportunity rebuild; enum ships early so intake/services can type against it without a second enum PR.

Available options:
OPEN,
WON,
LOST,
DISQUALIFIED
source_channel
enum<string>[] | null

Filter by one or more originating source channels

How a marketing interaction was observed.

Reporting dimension #1 on the touchpoint ledger. Add values only with a writer in the same PR (TypedEnum decodes unmapped strings to None).

Available options:
META_LEAD_FORM,
GOOGLE_LEAD_FORM,
PAID_CLICK,
WEB_ORGANIC,
WEB_FORM,
WEB_CHAT,
PHONE_CALL,
SMS_INBOUND,
EMAIL_INBOUND,
DM_INSTAGRAM,
DM_FACEBOOK,
REFERRAL,
WALK_IN,
QR,
IMPORT,
OTHER
search
string | null

Search in name, email, phone

is_converted
boolean | null

Filter converted/unconverted opportunities

Response

Successful Response

data
OpportunitySummary · object[]
required
total
integer
required