Skip to main content
GET
Retrieve all deals.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Query Parameters

ownerUid
string | null

Uid of the owner of the deal, or -1 for unassigned deals and -2 for all assigned deals.

q
string | null

Match on the deal name, the pipeline stage name, or the account name.

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Name
string
required
Required string length: 1 - 250
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
Amount
number<decimal> | null
DueDate
string<date-time> | null
AssignedToPersonClientIdentifier
string | null
Maximum string length: 50
Weight
integer<int32>
DealPipelineStage
object | null
Account
Account · object | null

Circular reference to Account (not expanded here).

DealPeople
DealPerson · object[] | null
Contacts
string | null
AccountId
integer<int64>
Owner
Person · object | null

Circular reference to Person (not expanded here).

PipelineUid
string | null
Example: