GET /v1/pipelines/{pipelineId}/today
GET
/v1/pipelines/{pipelineId}/today
const url = 'https://seu-endereco-da-api/v1/pipelines/example/today';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/pipelines/example/today \ --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”pipelineId
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
total
required
Open deals in view with an overdue task or stale in stage
number
deals
required
At most 5, overdue task first, then the highest value
Array<object>
object
id
required
string
number
required
number
title
required
string
contact
required
object
id
required
string
name
required
string
stageId
required
string
stageName
required
string
valueCents
required
number
why
required
string
daysInStage
required
number
overdueTask
required
object
title
required
string
dueAt
required
string format: date-time
canEdit
required
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
Example
{ "deals": [ { "why": "overdue_task" } ]}