Skip to content

Get Deal Detail

GET
/deals/{deal_id}/detail

The full deal record the detail page reads.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id.

string

Deal id.

Query Parameters

include_revision

Include the optimistic-concurrency revision. Null in the response means this org has no revision tracking, so a save is unconditional - it does NOT mean revision 1.

boolean

Include the optimistic-concurrency revision. Null in the response means this org has no revision tracking, so a save is unconditional - it does NOT mean revision 1.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One deal, with the related data the detail page reads.

revision is the optimistic-concurrency token. It is None when the org has no canonical revision tracking provisioned - the app degrades rather than 503ing a read - and a null there means an unconditional save, NOT revision 1. Do not default it.

object
amount
Any of:
number
close_date
Any of:
string format: date-time
company_id
Any of:
string
created_at
Any of:
string format: date-time
currency
Any of:
string
description
Any of:
string
id
Any of:
string
name
Any of:
string
owner_id
Any of:
string
pipeline_id
Any of:
string
revision
Any of:
integer
stage
Any of:
string
stage_id
Any of:
string
status
Any of:
string
updated_at
Any of:
string format: date-time
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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