Deal (Interface)

A Deal represents a business transaction with a customer. A single ContactAssignment may have one or many Deals.

OBJECT SCHEMA

FieldTypeRequiredDescription
idUUIDYes

The unique ID of this object.

displayNamestringNo

Assignee-provided display name.

templateDealTemplateYes

The Deal Template defines the type of deal, for example a Listing Opportunity or a Purchase Transaction.

descriptionstringNo

Assignee-provided description.

statusstringYes

Current deal status, such as active, lost, converted or deleted.

currentStagestringYes

The name of the current Deal Stage. Lookup the Stage details in the related DealTemplate.

currentStageEntryDateDateTimeStringYes

The date the Deal entered into its current Stage.

lastUpdatedDateTimeStringNo

This is in addition to "updated" - it signifies the last time a user updated one of many qualifying related items (ex: note, tags, lists, send email, etc)

notesNote[]No

Assignee-entered notes.

titlestringNo

A calculated or user-provided deal title.

subtitlestringNo

A calculated subtitle to help understand the Deal details.

budgetMinfloatNo

Minimum budget, for purchase-type deals.

budgetMaxfloatNo

Maximum budget, for purchase-type deals.

amountfloatNo

The purchase or sale price.

closeDateDateTimeString \No

null

expireDateDateTimeString \No

null

customFieldsCustomField[]No

A list of custom fields and values.

typenamestringYes

The GraphQL type name of the object.

* indicates a required field

ENTITIES IMPLEMENTING INTERFACE

Updated July 23, 2026