Endpoint: Listando Negócios

Endpoint que permite a listagem dos negócios criados ou importados na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/expansao/negocio

Método: GET

A busca da lista de negócios é paginada. O endpoint é limitado a 100 registros por página.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Query parameters

Filtro	Valor	Descrição
start	Integer	Início da paginação (número da página). Padrão 0
limit	Integer	Número de registros por página. Máximo 100. Padrão 100
id	Integer	Código do nogócio
titulo	String	Titulo do negócio
responsavel	Integer	Código do responsavel do negócio
etapa	Integer	Código da etapa do negócio
funil	Integer	Código do funil do negocio

Exemplo

fetch("https://api.sults.com.br/api/v1/expansao/negocio?start=0&limit=100", {
	method: "GET",
	headers: {
		"Authorization":"<token_de_acesso>",
		"Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
    "data": [
        {
            "id": 4,
            "titulo": "Negocio teste",
            "descricao": "Negocio teste",
            "dtCadastro": "2023-01-18T14:45:47Z",
            "dtConclusao": "2023-03-09T12:59:05Z",
            "cidade": "Uberaba",
            "uf": "MG",
            "valor": 0.00,
            "situacaoPerdaMotivoObservacao": "Motivo perda observação",
            "situacaoPerdaMotivo": {
                "id": 16,
                "nome": "Outros",
                "descricao": ""
            },
            "situacao": {
                "id": 3,
                "nome": "PERDA"
            },
            "etapa": {
                "id": 25,
                "nome": "Leads Novos",
                "funil": {
                    "id": 5,
                    "nome": "Funil teste"
                }
            },
            "campanha": {
                "id": 1,
                "nome": "Campanha das Mães"
            },
            "origem": {
                "id": 2,
                "nome": "Facebook"
            },
            "temperatura": {
                "id": 5,
                "nome": "Ardente"
            },
            "responsavel": {
                "id": 1,
                "nome": "SULTS"
            },
            "contatoEmpresa": {
                "id": 5,
                "nomeFantasia": "Teste",
                "razaoSocial": "Teste S.A.",
                "cnpj": "99999999999999",
                "cidade": "RIO DE JANEIRO",
                "uf": "RJ",
                "email": "teste@teste.com.br",
                "phone": "34999999999"
            },
            "etiqueta": [
                {
                    "id": 2,
                    "nome": "Etiqueta 2",
                    "cor": "#F4511E"
                },
                {
                    "id": 1,
                    "nome": "Etiqueta 1",
                    "cor": "#579bfc"
                }
            ],
            "contatoPessoa": [
                {
                    "id": 117,
                    "nome": "Juan Teste",
                    "phone": "34999999999",
                    "email": "teste@teste.com.br",
                    "cidade": "Uberaba",
                    "uf": "MG"
                }
            ],
            "participante": [
                {
                    "id": 2,
                    "nome": "Participante 1"
                },
                {
                    "id": 3,
                    "nome": "Participante 2"
                }
            ],
            "duracaoEtapa": [
                {
                    "etapa": {
                        "id": 25,
                        "nome": "Leads Novos",
                        "funil": {
                            "id": 5,
                            "nome": "Ascend"
                        }
                    },
                    "duracaoMinuto": 71893,
                    "dtUltimaVez": "2023-01-18T14:45:47Z",
                    "dtPrimeiraVez": "2023-01-18T14:45:47Z"
                }
            ],
            "campoAdicional": [
                {
                    "id": 186,
                    "nome": "Teste2",
                    "valor": ""
                }
            ]
        }
    ],
    "start": 1,
    "limit": 1,
    "size": 10,
    "totalPage": 1
}

Campos da resposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código do negócio
titulo	String	Título do chamado
descricao	String	Descrição do negócio
dtCadastro	String	Data em que o negócio foi criado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
dtConclusao	String	Data em que o negócio foi concluido. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
cidade	String	Cidade do negócio
uf	String	Estado do negócio
valor	String	Valor de investimento do negócio
situacaoPerdaMotivo	Objeto Situacao Perda Motivo – id – nome – descricao	Situação da perda do negócio
situacaoPerdaMotivoObservacao	String	Observação do motivo de perda do negócio
situacao	Objeto Situação: – id – nome Referente a um dos valores abaixo: 1 – Andamento 2 – Ganho 3 – Perda 4 – Adiado	Situação do negócio
etapa	Objeto Etapa	Etapa e funil que o negócio se encontra
campanha	Objeto Campanha: – id – nome	Campanha do negócio
origem	Objeto Origem: – id – nome	Origem do negócio
temperatura	Objeto Temperatura: – id – nome Referente a um dos valores abaixo: 1 – Gelado 2 – Frio 3 – Morno 4 – Quente 5 – Ardente	Temperatura do negócio
responsavel	Objeto Pessoa simplificado: – id – nome	Pessoa responsável do negócio
contatoEmpresa	Objeto Contato Empresa	Empresa de contato do negócio
etiqueta	Lista de Objeto Etiqueta: – id – nome – cor	Etiquetas do negócio
contatoPessoa	Objeto Contato Pessoa	Pessoa de contato do negócio
participante	Lista de Objetos Participante: – id – nome	Participante de negócio
duracaoEtapa	Lista de Objeto Duracao Etapa	Lista de duração que o negócio ficou na etapa. Nessa lista pode vir objeto etpas de funis anteriores.
campoAdicional	Lista de Objeto Campo Adicional	Lista de campos adicionais do negócio

Campos do Objeto Contato Empresa

Nome Atributo	Tipo	Descrição
id	Integer	Código da empresa de contato
nomeFantasia	String	Nome fantasia da empresa de contato
razaoSocial	String	Razão social da empresa de contato
cnpj	String	CNPJ da empresa de contato
phone	String	Telefone da empresa de contato
email	String	Email da empresa de contato
cidade	String	Cidade da empresa de contato
uf	String	Estado da empresa de contato

Campos do Objeto Contato Pessoa

Nome Atributo	Tipo	Descrição
id	Integer	Código da pessoa
nome	String	Nome da pessoa
phone	String	Telefone da pessoa
email	String	Email da pessoa
cidade	String	Cidade da pessoa
uf	String	Estado da pessoa

Campos do Objeto Etapa

Nome Atributo	Tipo	Descrição
id	Integer	Código da etapa
nome	String	Nome da etapa
funil	Objeto Funil: – id – nome	Funil da etapa

Campos do Objeto Duração Etapa

Nome Atributo	Tipo	Descrição
etapa	Objeto Etapa	Etapa do negócio
duracaoMinuto	Integer	Tempo em minutos que o negócio esteve nessa etapa
dtUltimaVez	String	Data em que o negócio esteve nesta etapa pela última vez. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
dtPrimeiraVez	String	Data em que o negócio esteve nesta etapa pela primeira vez. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z

Campos do Objeto Campo Adicional

Nome Atributo	Tipo	Descrição
id	Integer	Código do campo adicional
nome	String	Nome do campo adicional
valor	Object	Valor do campo adicional.

Atualizado em 25/09/2023