v1

latestOpenAPI 3.0.02026-07-26184308346.0 KB
CRM

Listar assuntos

get/crm/assuntos

Query parameters

situacao'pendente' | 'encerrado'

Filtra pelo status das ações do assunto

  • pendente - Com ações pendentes
  • encerrado - Sem ações pendentes/todas concluídas
estrelaboolean

Filtra apenas assuntos marcados com estrela

arquivadoboolean

Filtra apenas assuntos arquivados

idContatointeger

Filtra pelo ID do contato vinculado ao assunto

idPessoaContatointeger

Filtra pelo ID da pessoa de contato vinculada ao assunto

nomeClientestring

Pesquisa por nome do cliente vinculado ao assunto

statusCrm'L' | 'P' | 'C' | 'I'

Filtra pelo status CRM do contato vinculado ao assunto

  • L - Lead
  • P - Prospect
  • C - Cliente
  • I - Inativo
idEstagiointeger

Filtra pelo id do estágio no funil de vendas

assuntostring

Busca por texto na descrição do assunto parcial ou completo

filtrarPor'data-criacao' | 'data-prevista' | 'quanto-antes' | 'esperar'

Define o critério de filtro

  • data-criacao - Data de criação do assunto
  • data-prevista - Ações com data prevista (tipo D)
  • quanto-antes - Ações quanto antes (tipo Q)
  • esperar - Ações para esperar (tipo E)
dataInicialstring
Example:2024-01-01

Data inicial para filtro (aplica-se ao critério escolhido em 'filtrarPor')

dataFinalstring
Example:2024-12-31

Data final para filtro (aplica-se ao critério escolhido em 'filtrarPor')

string[]
OR
string

Pesquisa por marcadores

descricaoAcaostring

Busca por texto na descrição da ação do assunto parcial ou completo

idUsuariointeger

Filtra pelo id do usuário que criou as ações do assunto

idUsuarioResponsavelinteger

Filtra pelo id do usuário responsável pelas ações do assunto

limitinteger

Limite da paginação

offsetinteger

Offset da paginação

Response

OK

Example response

{
  "itens": [
    {
      "data": "2024-01-01",
      "dataAtualizacao": "2024-01-01 00:00:00",
      "proximaAcao": {
        "data": "2024-01-01"
      }
    }
  ]
}