SunchatPlus

Listar negócios do pipeline

Lista os negócios de um pipeline

GEThttps://api-publica.sunchat.com.br/v1/pipelines/{idPipeline}/negocios

Filtros: search (titulo/descricao/numero), idEtapa, idContato, idUsuarioResponsavel, arquivado, tipoArquivamento (Ativo/Arquivado/Ganho/Perdido), vencimentoInicio/Fim.

curl --request GET \
  --url 'https://api-publica.sunchat.com.br/v1/pipelines/{idPipeline}/negocios?search=&idEtapa=&idContato=' \
  --header 'X-Ambiente: SEU_NUMERO_DE_CONTA' \
  --header 'X-Authorization: X-Chave-Api SUA_CHAVE'

Autenticação

X-Ambientestring (header)obrigatório

Número da sua conta no SunchatPlus. Aceita também `X-Canal` com o ID de um canal, que resolve a conta a partir dele.

X-Authorizationstring (header)obrigatório

Chave de API no formato `X-Chave-Api {chave}`. O prefixo faz parte do valor. A chave fica em Minha conta › Integrações.

Parâmetros de caminho

idPipelinestring<uuid>obrigatório

Parâmetros de consulta

searchstring
idEtapastring<uuid>
idContatostring<uuid>
idUsuarioResponsavelstring<uuid>
arquivadoboolean
tipoArquivamentostring
prioridadestring
vencimentoIniciostring<date-time>
vencimentoFimstring<date-time>
pageinteger<int32>
pageSizeinteger<int32>
sortstring

Resposta 200

OK
Itemsobject[] | null
Idstring<uuid>
Numerointeger<int32>
Titulostring | null
Descricaostring | null
Ordeminteger<int32>
DataDaCriacaostring<date-time>
Vencimentostring<date-time> | null
Arquivadoboolean
TipoArquivamentostring | null
Prioridadestring | null
ValorAtribuidonumber<double>
ValorRecorrenteAtribuidonumber<double>
IdPipelinestring<uuid>
IdEtapastring<uuid> | null
IdContatoPrincipalstring<uuid> | null
NomeContatoPrincipalstring | null
IdPessoastring<uuid> | null
NomePessoastring | null
IdUsuarioResponsavelstring<uuid> | null
NomeUsuarioResponsavelstring | null
IdsEtiquetasstring<uuid>[] | null
CamposPersonalizadosobject[] | null
Pageinteger<int32>
PageSizeinteger<int32>
TotalItemsinteger<int64>
TotalPagesinteger<int32>
HasNextboolean
HasPreviousboolean

Resposta 404

Not Found
typestring | null
titlestring | null
statusinteger<int32> | null
detailstring | null
instancestring | null