Skip to main content
GET
List deals
Deals are read-only. Your CRM is the source of truth, and OpenNous reads it.

Implied deals

An account with no CRM deal still has a deal, its implied deal. That covers workspaces without a CRM and accounts the CRM has no deal for. An implied deal has the id implied:<account_id> and implied: true. Its stage is the account’s stage, and it has no pipeline or close date. It works anywhere a deal id does, in get a deal and as the focus of get context.

How the objects fit

All three share the standard ladder. See list pipelines for how your CRM stages map onto it.

Authorizations

Authorization
string
header
required

Workspace API key. Create one in Settings → API keys.

Query Parameters

account
string

Only one account's deals. Entity UUID or domain.

pipeline
string

CRM pipeline id. Excludes implied deals.

status
enum<string>

Deal status.

Available options:
open,
won,
lost
stage
enum<string>

Standard stage (canonical_stage).

Available options:
identified,
connected,
interested,
meeting_booked,
discovery,
demo,
negotiation,
closed_won,
closed_lost,
disqualified,
churned
owner
string

CRM owner. An email or a name.

closing_within_days
integer

Open deals with a close date from today to N days out. Excludes implied deals.

Required range: 1 <= x <= 3650
min_amount
number

Minimum amount.

implied
boolean

true for implied deals only, false for CRM deals only.

sort
enum<string>
default:last_activity

close_date is soonest first. The others are highest or newest first.

Available options:
last_activity,
close_date,
amount,
win_probability
limit
integer
default:50

Page size.

Required range: 1 <= x <= 200
offset
integer
default:0

Rows to skip.

Required range: x >= 0

Response

A page of deals.

deals
object[]
limit
integer
offset
integer
has_more
boolean