List deals (rows only)

get

https://sales-api.paymongo.com/v1/internal/deals

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

string

Cursor

limit

integer

Limit (1–50)

ids

array of strings

Comma-separated or repeated entity IDs (match any)

ids

pipeline_id

array of strings

Comma-separated or repeated pipeline IDs (match any)

pipeline_id

stage_id

array of strings

Comma-separated or repeated stage IDs (match any)

stage_id

name

string

Substring match on deal name or deal id (ILIKE, OR)

date_from

string

Created at lower bound (RFC3339)

date_to

string

Created at upper bound (RFC3339)

organization_ids

array of strings

Comma-separated or repeated organization IDs linked via organization_deal

organization_ids

contact_ids

array of strings

Comma-separated or repeated contact IDs linked via deal_contact

contact_ids

lead_ids

array of strings

Comma-separated or repeated lead IDs linked via deal_lead

lead_ids

tag_ids

array of strings

Comma-separated or repeated tag IDs linked via deal_tag

tag_ids

ticket_ids

array of strings

Comma-separated or repeated ticket IDs linked via deal_ticket

ticket_ids

owner_ids

array of strings

Comma-separated or repeated record owner IDs linked via owner_deal (match any)

owner_ids

included_in_forecast

boolean

Filter by included_in_forecast

is_closed

boolean

Filter by is_closed (ignored when outcome is set)

is_won

boolean

Filter by is_won (ignored when outcome is set)

outcome

array of strings

Comma-separated or repeated outcomes: open, won, lost (OR). Prefer this over is_closed/is_won.

outcome

monthly_incremental_tpv_from

number

monthly_incremental_tpv lower bound, inclusive

monthly_incremental_tpv_to

number

monthly_incremental_tpv upper bound, inclusive

monthly_incremental_gp_from

number

monthly_incremental_gp lower bound, inclusive

monthly_incremental_gp_to

number

monthly_incremental_gp upper bound, inclusive

daily_incremental_gp_from

number

daily_incremental_gp lower bound, inclusive

daily_incremental_gp_to

number

daily_incremental_gp upper bound, inclusive

sort_by

string

Sort field: name (default), created_at, expected_close

order_by

string

Sort direction: asc or desc (name/expected_close default asc, created_at default desc)

Responses

200OK

400Bad Request

500Internal Server Error