GET /v1/deals/{id}
const url = 'https://seu-endereco-da-api/v1/deals/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”Responses
Seção intitulada “Responses”object
Sequential per tenant, shown as #número
Data prevista de fechamento
object
object
Filled only while the deal sits in the intake stage
object
First inbound message of the conversation that opened the lead
Who is serving the conversation, when someone is
object
Whole days since the lead arrived
The lead’s contact is blocked; accept and restore refuse it until it is unblocked
object
Channel key derived from the contact’s provider
object
object
Set when the deal belongs to a group conversation instead of a contact
object
Public url for the user’s photo
object
Open task with the earliest due date
object
Se quem chama pode concluir esta tarefa (a mesma regra de POST /tasks/:id/complete)
Unread messages on the linked conversation
Days in the stage once past the stage’s staleDays, else null
The won deal of another pipeline that created this card automatically
object
Whose deals contactMetrics and otherDeals are computed from
Valores dos campos personalizados do negocio (entity deal), pela chave do campo
object
object
Public url for the user’s photo
object
Unit price in centavos
object
Total time spent in the stage; still ticking for the current one
object
object
Sequential per tenant, shown as #número
Data prevista de fechamento
object
object
Filled only while the deal sits in the intake stage
object
First inbound message of the conversation that opened the lead
Who is serving the conversation, when someone is
object
Whole days since the lead arrived
The lead’s contact is blocked; accept and restore refuse it until it is unblocked
object
Channel key derived from the contact’s provider
object
object
Set when the deal belongs to a group conversation instead of a contact
object
Public url for the user’s photo
object
Open task with the earliest due date
object
Se quem chama pode concluir esta tarefa (a mesma regra de POST /tasks/:id/complete)
Unread messages on the linked conversation
Days in the stage once past the stage’s staleDays, else null
object
object
Se quem chama pode concluir esta tarefa obrigatoria (a mesma regra de POST /tasks/:id/complete)
The caller holds deals:manage and the deal policy lets them act on this deal
The same next step as the board card
object
What the seller should do next, written by the pipeline AI from the conversation
When the AI wrote it
The last move of this deal made by the AI, if any
object
What to talk about in the deal’s stage, from the sales playbook, without calling the AI
object
Generic when the sales playbook has no checklist for this stage
Example
{ "status": "open", "intake": { "source": "inbound_message" }, "metricsScope": "company", "otherDeals": [ { "status": "open", "intake": { "source": "inbound_message" } } ], "checklist": { "source": "playbook" }}