deals_list_response
payload object[]
The ID of the deal
The name of the deal
Sum of the recurring line items
Sum of the one-off line items
Sum of both, and the value the funnel totals are built from
ISO 4217 code. Set per deal, so one pipeline can hold deals in more than one currency.
BRLThe date the deal is expected to close
How promising the deal looks, on the scale the board renders as stars
Only ongoing deals count towards a stage's open value
Possible values: [ongoing, won, lost, paused]
Unix timestamp of when the deal was won or lost. Absent while it is ongoing.
Order of the card inside its stage
The ID of the pipeline the deal belongs to
The ID of the stage the deal currently sits in
The user responsible for the deal. Only the owner is reminded about its tasks.
The user who created the deal
Where the deal came from
Why the deal was lost. Only meaningful when status is lost.
Free-text detail on the loss
The company the deal belongs to
The campaign that originated the deal
The contacts on the deal. A deal always has at least one.
Co-owners. They see the deal but are not reminded about its tasks.
Values of the account's custom fields, keyed by field key
Free-text notes on the deal
Label names applied to the deal
Unix timestamp of the last stage change
Unix timestamp of creation
Unix timestamp of the last update
owner object
Present when the deal has an owner
assignees object[]
Tasks attached to the deal
Tasks past their due date and not completed. The board marks the card when this is above zero.
last_message object
Preview of the most recent message with the deal's contact. Absent when there is no conversation.
contacts object[]
products object[]
Product line items. Their prices are what recurrence_price and one_time_price are computed from.
Null for a line item typed by hand rather than picked from the catalog
Billing cadence of the line. Empty for a one-off charge.
services object[]
Service line items, same shape as the products
lost_reason object
Present when the deal was lost with a reason
organization object
Present when the deal belongs to a company
meta object
Deals matching the filters, across every page
summary object[]
Totals per stage over the whole filtered set, not just this page — so a board holding one page of cards still reports each column truthfully.
Every deal in the stage, whatever its status
Deals still ongoing
Sum of the open deals' total_price. Only meaningful when the stage
holds a single currency — read open_values otherwise.
open_values object[]
The open value broken down by currency
{
"payload": [
{
"id": 0,
"name": "string",
"recurrence_price": 0,
"one_time_price": 0,
"total_price": 0,
"currency": "BRL",
"expected_close_date": "2024-07-29",
"rating": 0,
"status": "ongoing",
"closed_at": 0,
"position": 0,
"pipeline_id": 0,
"stage_id": 0,
"owner_id": 0,
"created_by_id": 0,
"source_id": 0,
"lost_reason_id": 0,
"lost_reason_note": "string",
"organization_id": 0,
"campaign_id": 0,
"contact_ids": [
0
],
"assignee_ids": [
0
],
"custom_fields": {},
"notes": "string",
"labels": [
"string"
],
"stage_changed_at": 0,
"created_at": 0,
"updated_at": 0,
"owner": {
"id": 0,
"name": "string",
"avatar_url": "string"
},
"assignees": [
{
"id": 0,
"name": "string",
"avatar_url": "string"
}
],
"tasks_count": 0,
"completed_tasks_count": 0,
"overdue_tasks_count": 0,
"last_message": {
"conversation_id": 0,
"content": "string",
"message_type": "string",
"channel_type": "string",
"medium": "string",
"unread_count": 0
},
"contacts": [
{
"id": 0,
"name": "string",
"email": "string"
}
],
"products": [
{
"id": 0,
"product_id": 0,
"name": "string",
"quantity": 0,
"price": 0,
"recurrence": "string"
}
],
"services": [
{
"id": 0,
"service_id": 0,
"name": "string",
"quantity": 0,
"price": 0,
"recurrence": "string"
}
],
"lost_reason": {
"id": 0,
"name": "string"
},
"organization": {
"id": 0,
"name": "string"
}
}
],
"meta": {
"count": 0,
"current_page": 0,
"per_page": 0,
"total_pages": 0,
"summary": [
{
"stage_id": 0,
"total_count": 0,
"open_count": 0,
"open_value": 0,
"open_values": [
{
"currency": "string",
"value": 0
}
]
}
]
}
}