Skip to content

List Account Deals

GET
/accounts/{account_id}/deals

Deals on one account.

No per-record gate: a LIST is filtered by deal_scope, which the app handler takes as a parameter and applies itself. Gating row by row here would be both redundant and wrong - there is no single deal id to check.

Authorizations

Parameters

Path Parameters

account_id
required

Account id.

string

Account id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of deals on one account.

object
deals
Array<object>

One deal as it appears in a list.

object
amount
Any of:
number
close_date
Any of:
string format: date-time
created_at
Any of:
string format: date-time
currency
Any of:
string
id
Any of:
string
name
Any of:
string
owner_id
Any of:
string
pipeline_id
Any of:
string
stage
Any of:
string
status
Any of:
string
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string