Pular para o conteúdo

GET /v1/deals/{id}

GET
/v1/deals/{id}
curl --request GET \
--url https://seu-endereco-da-api/v1/deals/example \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler negócios (deals:read).

id
required
string
Media typeapplication/json
object
id
required
string
number
required

Sequential per tenant, shown as #número

number
title
required
string
nullable
status
required
string
Allowed values: open won lost
valueCents
required
number
stageId
required
string
stageEnteredAt
required
string format: date-time
createdAt
required
string format: date-time
expectedCloseAt
required

Data prevista de fechamento

string format: date-time
nullable
wonAt
required
string format: date-time
nullable
lostAt
required
string format: date-time
nullable
lossReason
required
object
id
required
string
name
required
string
winReason
required
object
id
required
string
name
required
string
intake
required

Filled only while the deal sits in the intake stage

object
firstMessage
required

First inbound message of the conversation that opened the lead

string
nullable
receivedAt
required
string format: date-time
source
required
string
Allowed values: inbound_message ad form
originName
required
string
nullable
servedBy
required

Who is serving the conversation, when someone is

object
id
required
string
name
required
string
nullable
waitingDays
required

Whole days since the lead arrived

number
contactBlocked
required

The lead’s contact is blocked; accept and restore refuse it until it is unblocked

boolean
contact
required
object
id
required
string
name
required
string
channel
required

Channel key derived from the contact’s provider

string
provider
required
string
profilePicUrl
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
company
required
object
id
required
string
name
required
string
groupName
required

Set when the deal belongs to a group conversation instead of a contact

string
nullable
groupProvider
required
string
nullable
groupProfilePicUrl
required
string
nullable
assignee
required
object
id
required
string
name
required
string
nullable
avatarUrl
required

Public url for the user’s photo

string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
nextTask
required

Open task with the earliest due date

object
id
required
string
title
required
string
dueAt
required
string format: date-time
isRequired
required
boolean
canComplete
required

Se quem chama pode concluir esta tarefa (a mesma regra de POST /tasks/:id/complete)

boolean
openTaskCount
required
number
unreadCount
required

Unread messages on the linked conversation

number
staleDays
required

Days in the stage once past the stage’s staleDays, else null

number
nullable
handoffOrigin
required

The won deal of another pipeline that created this card automatically

object
dealId
required
string
number
required
number
pipelineId
required
string
pipelineName
required
string
wonAt
required
string format: date-time
nullable
pipelineId
required
string
contactId
required
string
nullable
companyId
required
string
nullable
metricsScope
required

Whose deals contactMetrics and otherDeals are computed from

string
nullable
Allowed values: company contact
assigneeId
required
string
nullable
conversationId
required
string
nullable
note
required
string
nullable
attributes
required

Valores dos campos personalizados do negocio (entity deal), pela chave do campo

object
lostNote
required
string
nullable
createdBy
required
object
id
required
string
name
required
string
nullable
avatarUrl
required

Public url for the user’s photo

string
nullable
products
required
Array<object>
object
id
required
string
name
required
string
price
required

Unit price in centavos

number
quantity
required
number
stageDurations
required
Array<object>
object
stageId
required
string
name
required
string
colorKey
required
string
enteredAt
required
string format: date-time
nullable
leftAt
required
string format: date-time
nullable
seconds
required

Total time spent in the stage; still ticking for the current one

number
nullable
current
required
boolean
contactMetrics
required
object
wonCount
required
number
wonValueCents
required
number
avgTicketCents
required
number
avgCycleDays
required
number
nullable
lastWonAt
required
string format: date-time
nullable
otherDeals
required
Array<object>
object
id
required
string
number
required

Sequential per tenant, shown as #número

number
title
required
string
nullable
status
required
string
Allowed values: open won lost
valueCents
required
number
stageId
required
string
stageEnteredAt
required
string format: date-time
createdAt
required
string format: date-time
expectedCloseAt
required

Data prevista de fechamento

string format: date-time
nullable
wonAt
required
string format: date-time
nullable
lostAt
required
string format: date-time
nullable
lossReason
required
object
id
required
string
name
required
string
winReason
required
object
id
required
string
name
required
string
intake
required

Filled only while the deal sits in the intake stage

object
firstMessage
required

First inbound message of the conversation that opened the lead

string
nullable
receivedAt
required
string format: date-time
source
required
string
Allowed values: inbound_message ad form
originName
required
string
nullable
servedBy
required

Who is serving the conversation, when someone is

object
id
required
string
name
required
string
nullable
waitingDays
required

Whole days since the lead arrived

number
contactBlocked
required

The lead’s contact is blocked; accept and restore refuse it until it is unblocked

boolean
contact
required
object
id
required
string
name
required
string
channel
required

Channel key derived from the contact’s provider

string
provider
required
string
profilePicUrl
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
company
required
object
id
required
string
name
required
string
groupName
required

Set when the deal belongs to a group conversation instead of a contact

string
nullable
groupProvider
required
string
nullable
groupProfilePicUrl
required
string
nullable
assignee
required
object
id
required
string
name
required
string
nullable
avatarUrl
required

Public url for the user’s photo

string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
nextTask
required

Open task with the earliest due date

object
id
required
string
title
required
string
dueAt
required
string format: date-time
isRequired
required
boolean
canComplete
required

Se quem chama pode concluir esta tarefa (a mesma regra de POST /tasks/:id/complete)

boolean
openTaskCount
required
number
unreadCount
required

Unread messages on the linked conversation

number
staleDays
required

Days in the stage once past the stage’s staleDays, else null

number
nullable
conversations
required
Array<object>
object
id
required
string
channel
required
string
status
required
string
lastMessageAt
required
string format: date-time
nullable
unreadCount
required
number
requiredOpenTasks
required
Array<object>
object
id
required
string
title
required
string
dueAt
required
string format: date-time
canComplete
required

Se quem chama pode concluir esta tarefa obrigatoria (a mesma regra de POST /tasks/:id/complete)

boolean
canEdit
required

The caller holds deals:manage and the deal policy lets them act on this deal

boolean
nextStep
required

The same next step as the board card

object
text
required

What the seller should do next, written by the pipeline AI from the conversation

string
writtenAt
required

When the AI wrote it

string format: date-time
aiAction
required

The last move of this deal made by the AI, if any

object
checklist
required

What to talk about in the deal’s stage, from the sales playbook, without calling the AI

object
source
required

Generic when the sales playbook has no checklist for this stage

string
Allowed values: playbook generic
stageName
required
string
nullable
items
required
Array<string>

Example

{
"status": "open",
"intake": {
"source": "inbound_message"
},
"metricsScope": "company",
"otherDeals": [
{
"status": "open",
"intake": {
"source": "inbound_message"
}
}
],
"checklist": {
"source": "playbook"
}
}