> ## Documentation Index > Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar negócios > Lista os negócios criados ou importados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/expansao/negocio openapi: 3.1.0 info: title: API SULTS version: v1 description: >- API REST do SULTS. Todas as chamadas devem ser autenticadas por um token enviado, puro e sem o prefixo `Bearer`, no cabeçalho HTTP `Authorization`. As datas seguem o formato UTC ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`) e campos com máscara (CNPJ, telefone, CEP etc.) são retornados sem máscara. Endpoints de listagem paginados aceitam os parâmetros `start` e `limit`. contact: name: Suporte SULTS url: https://ajuda.sults.com.br servers: - url: https://api.sults.com.br description: Produção security: - apiKeyAuth: [] tags: - name: Unidades description: >- Unidades da rede e colaboradores ativos cadastrados no SULTS. Somente leitura: a API não grava unidades nem colaboradores. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Chamados description: >- Chamados abertos na plataforma e a timeline de cada um, com os endpoints de criação e conclusão. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Checklist description: >- Avaliações de checklist aplicadas nas unidades, com respostas, check-ins, check-outs e planos de ação. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: Compras description: >- Pedidos de compra e catálogo de produtos da v1, incluindo o cadastro e a edição de produto e a edição de pedido. A v1 de Compras não recebe novas funcionalidades: mix de produtos, etapas de pedido e as próximas novidades do módulo estão só na API v2, que é a indicada para integrações novas de Compras. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: implantacao description: >- Projetos de implantação de novas unidades e as tarefas de cada projeto. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Implantação - name: Projetos description: >- Projetos da operação e as tarefas vinculadas a eles. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. - name: expansao description: >- Negócios do funil de Expansão e a timeline de cada um, com o endpoint de criação de negócio. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado por um administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP. x-group: Expansão paths: /api/v1/expansao/negocio: get: tags: - expansao summary: Listar negócios description: >- Lista os negócios criados ou importados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. operationId: listarNegocios parameters: - $ref: '#/components/parameters/Start' - $ref: '#/components/parameters/Limit' - name: id in: query required: false description: Código do negócio schema: type: integer example: 1 - name: titulo in: query required: false description: Título do negócio schema: type: string example: Nova unidade em Belo Horizonte - name: responsavel in: query required: false description: Código do responsável do negócio schema: type: integer example: 8 - name: etapa in: query required: false description: Código da etapa do negócio schema: type: integer example: 3 - name: funil in: query required: false description: Código do funil do negócio schema: type: integer example: 1 responses: '200': description: Lista paginada de negócios content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Negocio' start: type: integer description: Página retornada limit: type: integer description: Registros por página totalPage: type: integer description: Quantidade de páginas disponíveis size: type: integer description: Quantidade de registros na página '400': $ref: '#/components/responses/ErroValidacao' '401': $ref: '#/components/responses/TokenInvalido' '404': $ref: '#/components/responses/NaoEncontrado' '429': $ref: '#/components/responses/LimiteDeRequisicoes' 5XX: $ref: '#/components/responses/ErroDoServidor' components: parameters: Start: name: start in: query description: >- Número da página da listagem, começando em `0`. Incremente até a resposta vir vazia ou até atingir `totalPage`. schema: type: integer minimum: 0 default: 0 example: 0 Limit: name: limit in: query description: Quantidade de registros por página. O máximo aceito pela API é `100`. schema: type: integer minimum: 1 maximum: 100 default: 100 example: 100 schemas: Negocio: type: object properties: id: type: integer description: Código do negócio example: 1 titulo: type: string description: Título do negócio example: Nova unidade em Belo Horizonte descricao: type: string description: Descrição do negócio example: Item padrão do checklist de abertura. dtCadastro: type: string format: date-time description: Data em que o negócio foi criado (UTC ISO 8601) example: '2026-08-04T11:20:00Z' dtConclusao: type: string format: date-time description: Data em que o negócio foi concluído (UTC ISO 8601) example: '2026-10-10T17:00:00Z' cidade: type: string description: Cidade do negócio example: Uberaba uf: type: string description: Estado do negócio example: MG valor: type: number description: Valor de investimento do negócio example: 24.9 situacaoPerdaMotivo: type: object description: Motivo da perda do negócio properties: id: type: integer description: Código do motivo example: 1 nome: type: string description: Nome do motivo example: Capital insuficiente descricao: type: string description: Descrição do motivo example: Item padrão do checklist de abertura. situacaoPerdaMotivoObservacao: type: string description: Observação do motivo de perda do negócio example: Candidato decidiu adiar o investimento para 2027 situacao: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: >- Situação do negócio: 1 Andamento/Aberto; 2 Ganho; 3 Perdido. Confirmado pela engenharia: o valor 4 (Adiado) da documentação antiga não existe. etapa: type: object description: Etapa e funil properties: id: type: integer description: Código da etapa example: 1 nome: type: string description: Nome da etapa example: Reunião de apresentação funil: type: object description: Funil da etapa properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Expansão Sudeste campanha: type: object description: Campanha do negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Feira de franquias 2026 origem: type: object description: Origem do negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Site temperatura: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: >- Temperatura do negócio: 1 Gelado; 2 Frio; 3 Morno; 4 Quente; 5 Ardente. responsavel: type: object description: Pessoa responsável pelo negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Patrícia Lima contatoEmpresa: type: object description: Empresa de contato do negócio properties: id: type: integer description: Código da empresa de contato example: 1 nomeFantasia: type: string description: Nome fantasia da empresa de contato example: Tavares Investimentos razaoSocial: type: string description: Razão social da empresa de contato example: SULTS Tecnologia LTDA cnpj: type: string description: CNPJ da empresa de contato example: '12345678000190' phone: type: string description: Telefone da empresa de contato example: '34988776655' email: type: string description: E-mail da empresa de contato example: operacoes@sabormineiro.com.br cidade: type: string description: Cidade da empresa de contato example: Uberaba uf: type: string description: Estado da empresa de contato example: MG etiqueta: type: array items: $ref: '#/components/schemas/Etiqueta' description: Etiquetas do negócio contatoPessoa: type: array description: Pessoas de contato do negócio items: type: object properties: id: type: integer description: Código da pessoa example: 1 nome: type: string description: Nome da pessoa example: Marcos Tavares phone: type: string description: Telefone da pessoa example: '34988776655' email: type: string description: E-mail da pessoa example: operacoes@sabormineiro.com.br cidade: type: string description: Cidade da pessoa example: Uberaba uf: type: string description: Estado da pessoa example: MG participante: type: array items: type: object description: Participante do negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Rafael Souza description: Participantes do negócio duracaoEtapa: type: array description: >- Duração que o negócio ficou em cada etapa. Nessa lista podem vir etapas de funis anteriores. items: type: object properties: etapa: type: object description: Etapa e funil properties: id: type: integer description: Código da etapa example: 1 nome: type: string description: Nome da etapa example: Reunião de apresentação funil: type: object description: Funil da etapa properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Expansão Sudeste duracaoMinuto: type: integer description: Tempo em minutos que o negócio esteve nessa etapa example: 1 dtUltimaVez: type: string format: date-time description: >- Data em que o negócio esteve nesta etapa pela última vez (UTC ISO 8601) example: '2026-09-02T16:30:00Z' dtPrimeiraVez: type: string format: date-time description: >- Data em que o negócio esteve nesta etapa pela primeira vez (UTC ISO 8601) example: '2026-08-12T14:00:00Z' campoAdicional: type: array description: Campos adicionais do negócio items: type: object properties: nome: type: string description: Nome do campo adicional example: Capital disponível valor: description: Valor do campo adicional (tipo dinâmico) IdNomeExpansao: type: object properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Site Etiqueta: type: object properties: id: type: integer description: Código da etiqueta example: 1 nome: type: string description: Nome da etiqueta example: Urgente cor: type: string description: Cor da etiqueta (hex) example: Verde Erro: type: object description: >- Corpo padrão de erro da API. Não existe código de erro interno: decida a sua lógica pelo status HTTP e use a mensagem apenas para logs e diagnóstico. required: - error properties: error: type: string description: >- Mensagem legível, em português, descrevendo a falha. O texto pode mudar: nunca o use como condição de código. example: Campo responsavel não pode ser vazio ou nulo. responses: ErroValidacao: description: >- Erro de validação ou formato errado nos dados de entrada. A API aponta **um campo por vez**: corrija o campo indicado na mensagem, reenvie e repita até o 200. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Campo responsavel não pode ser vazio ou nulo. TokenInvalido: description: >- Token ausente ou inválido. Confira: copiado por completo, cabeçalho `Authorization` com o nome exato, valor sem o prefixo `Bearer` e gerado na **Gestão de Tokens v1** (tokens v2 não funcionam nesta API). Sem retry automático. O corpo real é `{"error": "Acesso não autorizado."}`. content: application/json: schema: $ref: '#/components/schemas/Erro' example: error: Acesso não autorizado. NaoEncontrado: description: >- Recurso ou entidade inexistente (por exemplo, um `{id}` do caminho que não existe ou foi excluído no SULTS). Reenviar sem corrigir devolve o mesmo erro. content: application/json: schema: $ref: '#/components/schemas/Erro' LimiteDeRequisicoes: description: >- Limite de requisições excedido: **2 requisições por segundo, por IP**. A resposta é a página HTML padrão do servidor, não JSON, e não há o header `Retry-After`: trate pelo status 429, sem fazer parse do corpo, com espera crescente a partir de 1 segundo. content: text/html: schema: type: string description: >- Página HTML padrão do servidor. Não faça parse; decida pelo status. ErroDoServidor: description: >- Falha inesperada do servidor (raro). Repita com espera crescente; persistindo, acione o suporte com data, hora e endpoint. content: application/json: schema: $ref: '#/components/schemas/Erro' securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: >- Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho `Authorization` de todas as requisições. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.