O que fazer hoje

GET

/v1/tasks/today

const url = 'https://developers.nexo.winningsales.com.br/v1/tasks/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://developers.nexo.winningsales.com.br/v1/tasks/today \
  --header 'Authorization: Bearer <token>'

A lista do dia do vendedor, gerada por regra (sem modelo) às 7h no fuso da empresa e a cada mudança relevante: reuniões do dia, compromissos vencendo, follow-ups sem resposta, fechamento escorregando, negócios parados, campos esperando revisão. Reuniões primeiro, pela hora; o resto por impacto na meta. O vendedor vê só o próprio dia; admin e líder escolhem o vendedor por ownerId.

Authorizations

bearer

Parameters

Query Parameters

ownerId

Dono do CRM de quem ver o dia; só admin e líder escolhem, o vendedor sempre vê o próprio

string format: uuid

Dono do CRM de quem ver o dia; só admin e líder escolhem, o vendedor sempre vê o próprio

Responses

200

As tarefas do dia

application/json

object

day

required

O dia, AAAA-MM-DD, no fuso da empresa

string

ownerId

required

Dono do CRM de quem é o dia; null quando o usuário não tem dono ligado

string format: uuid

nullable

ownerName

required

Nome do dono no CRM

string

nullable

pending

required

Tarefas ainda por fazer

integer

total

required

Tarefas do dia, feitas e por fazer

integer

tasks

required

Reuniões do dia primeiro, pela hora; depois por impacto na meta, com a data mais próxima desempatando

Array<object>

object

required

Id da tarefa

string format: uuid

kind

required

A regra que gerou a tarefa; forecast_missing pede o forecast (compromisso e data) de um negócio a partir da etapa em que o funil pede a declaração; fill_expected_fields junta, num negócio só, os campos que o time costuma preencher na etapa atual e este negócio deixou em branco; buyer_commitment_due é o combinado que o cliente ficou de fazer e não fez; buyer_deadline_passed é o prazo do cliente que passou sem fato novo

string

Allowed values: meeting_today commitment_due buyer_commitment_due buyer_deadline_passed follow_up_no_reply slipping_close_date no_next_activity review_pending fill_expected_fields confirm_tomorrow_first_meetings forecast_missing

when

required

Quando fazer

object

kind

required

Tipo do quando

string

Allowed values: time today until end_of_day minutes

required

Hora da reunião ou prazo, ISO 8601; null quando é só “hoje”

string

nullable

label

required

O quando pronto para a tela: 10:00, hoje, até 14/09, fim do dia, 2 min

string

title

required

O que fazer, começando por um verbo

string

tag

required

Selo curto: reunião de hoje, 12 dias parado, 5 campos, 3 campos esperados, cliente deve · vence hoje, cliente deve · venceu há 3 dias, prazo do cliente

string

deal

required

O negócio da tarefa; null nas tarefas sem negócio (revisão, reuniões de amanhã)

object

required

Id do negócio

string format: uuid

name

required

Nome do negócio no CRM

string

amountInCents

required

Valor do negócio em centavos

integer

nullable

currency

required

Moeda do valor

string

hubspotUrl

required

Link do negócio no HubSpot, quando o CRM é o HubSpot

string

nullable

why

required

Por que a tarefa está na lista

object

text

required

O porquê: fatos do CRM e contas afirmados; leitura de conversa rotulada como leitura

string

evidence

required

A conversa e os trechos quando o porquê vem de uma leitura

object

channel

required

Canal da conversa de onde saiu a leitura (hoje, meeting)

string

conversationId

required

Id da conversa

string

excerptRefs

required

Trechos que sustentam o porquê (e1, e2…)

Array<string>

links

required

Para onde a tarefa leva

object

deal

required

True quando dá para abrir o raio X do negócio

boolean

review

required

True quando a tarefa leva à Revisão, para revisar ou preencher os campos

boolean

meetingId

required

Reunião do CRM para abrir a preparação

string format: uuid

nullable

draftKind

required

Tipo de rascunho que a tela pode pedir para esta tarefa

string

nullable

Allowed values: retomada follow_up objection cobranca

preparation

required

True quando a tarefa tem preparação da reunião

boolean

status

required

Open, done (marcada como feita), auto_closed (saiu sozinha: o sinal sumiu ou o prazo ainda não venceu quando o dia virou), cancelled (o vendedor cancelou com justificativa), expired (o dia virou e não foi feita) ou rescheduled (movida para outro dia)

string

Allowed values: open done auto_closed cancelled expired rescheduled

day

required

O dia da tarefa, AAAA-MM-DD, no fuso da empresa

string

commitmentKey

required

Nas tarefas de compromisso (commitment_due, buyer_commitment_due), a chave do combinado lido, para confirmar, corrigir ou descartar em PUT /deals/:dealId/commitments/:key; null quando o combinado veio do próximo passo e não tem chave real

string

nullable

rescheduledFromDay

required

Dia de onde a tarefa foi remarcada; null quando nasceu neste dia

string

nullable

rescheduleCount

required

Quantas vezes esta tarefa já foi remarcada

integer

cancellation

required

Presente quando o vendedor cancelou

object

reason

required

Por que cancelou: não faz mais sentido, o cliente resolveu por outro canal, negócio perdido ou pausado, a leitura estava errada, ou outro

string

Allowed values: no_longer_makes_sense solved_elsewhere deal_lost_or_paused wrong_reading other

note

required

A justificativa escrita pelo vendedor

string

Example

{
  "tasks": [
    {
      "kind": "meeting_today",
      "when": {
        "kind": "time"
      },
      "draftKind": "retomada",
      "status": "open",
      "cancellation": {
        "reason": "no_longer_makes_sense"
      }
    }
  ]
}

400

Filtro inválido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Token ausente, inválido, expirado ou revogado

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

429

Limite de chamadas da empresa ou do token atingido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}

O que fazer hoje

Authorizations

Parameters

Query Parameters

Responses

200

Example

400

Example generated

401

Example

403

Example

429

Example

Example ^generated