Get Deal

GET

/deals/{deal_id}

• Production
• QA

Get a single deal by ID.

Authorizations

• BearerAuth

Parameters

Path Parameters

deal_id

required

Deal ID (UUID)

string

Deal ID (UUID)

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

amount

Any of:

number

number

null

null

close_date

Any of:

string

string

null

null

closed_lost_reason

Any of:

string

string

null

null

company_id

Any of:

unknown

null

null

contact_count

integer

contacts

Any of:

Array<object>

Array<object>

Lightweight contact summary embedded in deal responses.

id is the canonical mashup_contact_id (BigInt), matching how contacts are addressed everywhere else in the public API (g8_search_contacts, g8_lookup_person, etc.). role is the contact’s role within THIS deal (champion / decision_maker / influencer / blocker / coach / end_user) and is null when no role was set.

object

email

Any of:

string

string

null

null

id

required

integer

name

Any of:

string

string

null

null

role

Any of:

string

string

null

null

title

Any of:

string

string

null

null

null

null

created_at

Any of:

string

string

null

null

currency

Any of:

string

string

null

null

description

Any of:

string

string

null

null

id

Any of:

string

string

null

null

last_activity_at

Any of:

string

string

null

null

name

Any of:

string

string

null

null

owner_email

Any of:

string

string

null

null

owner_id

Any of:

string

string

null

null

owner_name

Any of:

string

string

null

null

pipeline_id

Any of:

string

string

null

null

pipeline_name

Any of:

string

string

null

null

primary_contact

Any of:

ContactBrief

Lightweight contact summary embedded in deal responses.

id is the canonical mashup_contact_id (BigInt), matching how contacts are addressed everywhere else in the public API (g8_search_contacts, g8_lookup_person, etc.). role is the contact’s role within THIS deal (champion / decision_maker / influencer / blocker / coach / end_user) and is null when no role was set.

object

email

Any of:

string

string

null

null

id

required

integer

name

Any of:

string

string

null

null

role

Any of:

string

string

null

null

title

Any of:

string

string

null

null

null

null

revision

Any of:

integer

integer

null

null

stage_id

Any of:

string

string

null

null

stage_name

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string