Skip to main content
GET
Get deal by ID

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Deal UUID

Query Parameters

include
string

Comma-separated extra sections. Values: custom_fields, deal_status_changes. Default: custom_fields. Pass empty string for base fields only. Won/lost reasons, notes, and client_contacts are always included in the base deal detail. deal_status_changes embeds the recorded status history, oldest first, and is omitted unless requested. Passing this parameter replaces the default, so include custom_fields too when you still want it.

Response

Deal fetched

success
enum<boolean>
required
Available options:
true
data
object
required