> ## 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 timeline de negócio > Lista a timeline (interações e ações realizadas) de um negócio específico na plataforma do SULTS. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/expansao/negocio/{negocioId}/timeline 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/{negocioId}/timeline: get: tags: - expansao summary: Listar timeline de negócio description: >- Lista a timeline (interações e ações realizadas) de um negócio específico na plataforma do SULTS. operationId: listarTimelineNegocio parameters: - name: negocioId in: path required: true description: Id do negócio schema: type: integer example: 604 responses: '200': description: Timeline do negócio content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/NegocioTimelineItem' '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: schemas: NegocioTimelineItem: type: object properties: criado: type: string format: date-time description: Data em que foi criado o item da timeline do negócio (UTC ISO 8601) example: '2026-08-12T14:00:00Z' pessoa: type: object description: Pessoa que fez a interação na timeline do negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Patrícia Lima tipo: type: integer enum: - 1 - 2 - 4 - 5 - 6 - 8 - 9 - 10 - 11 description: >- O significado de cada valor ainda não foi confirmado pela engenharia. Enquanto isso, trate o campo como um código opaco e não derive regra de negócio a partir dele. example: 1 atividade: type: object description: Presente quando o tipo é 1 (atividade). properties: id: type: integer description: Código da atividade example: 1 nome: type: string description: Nome da atividade example: Ligar para o candidato descricaoHtml: type: string description: Descrição em HTML da atividade example:

Café torrado e moído, pacote de 500 g.

tipo: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: >- Tipo da atividade: 1 Tarefa; 2 Reunião; 3 Visita; 4 Ligação; 5 Email; 6 Mensagem. dtAgendado: type: string format: date-time description: Data de agendamento da atividade (UTC ISO 8601) example: '2026-08-14T13:00:00Z' dtConcluido: type: string format: date-time description: Data de conclusão da atividade (UTC ISO 8601) example: '2026-08-14T13:25:00Z' concluido: type: boolean description: Indica que a atividade foi concluída example: true criador: type: object description: Pessoa que criou a atividade properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Patrícia Lima responsavel: type: object description: Pessoa responsável por realizar a atividade properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Rafael Souza anexo: type: array items: $ref: '#/components/schemas/NegocioAnexo' description: Anexos da atividade mudancaSituacao: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: Presente quando o tipo é 2 (mudança de situação). mudancaEtapa: type: object description: Presente quando o tipo é 4 (mudança de etapa). properties: etapaAnterior: type: object description: Etapa anterior à mudança properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Qualificação etapaAtual: type: object description: Nova etapa do negócio properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Reunião de apresentação anotacao: type: object description: Presente quando o tipo é 5 (anotação). properties: id: type: integer description: Código da anotação example: 1 descricaoHtml: type: string description: Descrição em HTML da anotação example:

Café torrado e moído, pacote de 500 g.

editavel: type: boolean description: Indica se a anotação pode ser editada example: true dtAnotacao: type: string format: date-time description: Data da anotação (UTC ISO 8601) example: '2026-08-14T13:30:12Z' anexo: allOf: - $ref: '#/components/schemas/NegocioAnexo' description: Presente quando o tipo é 6 (anexo). email: type: object description: Presente quando o tipo é 8 (envio de e-mail). properties: id: type: integer description: Código do e-mail example: 1 assunto: type: string description: Assunto do e-mail example: Ar condicionado da loja com defeito mensagemHtml: type: string description: Mensagem em HTML do e-mail example:

Chamado aberto pela unidade.

dtEnviado: type: string format: date-time description: Data de envio do e-mail (UTC ISO 8601) example: '2026-08-15T09:12:48Z' remetente: type: string description: Remetente do e-mail example: expansao@sabormineiro.com.br destinatario: type: string description: Destinatário do e-mail example: marcos.tavares@example.com checkpoint: type: object description: Presente quando o tipo é 9 (checkpoint). properties: id: type: integer description: Código do checkpoint example: 1 nome: type: string description: Nome do checkpoint example: Documentação enviada descricaoHtml: type: string description: Descrição em HTML do checkpoint example:

Café torrado e moído, pacote de 500 g.

dtConcluido: type: string format: date-time description: Data de conclusão do checkpoint (UTC ISO 8601) example: '2026-08-18T17:40:00Z' 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: Análise de perfil 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 chamado: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: Presente quando o tipo é 10 (chamado). avaliacao: type: object description: Presente quando o tipo é 11 (avaliação). properties: id: type: integer description: Código da avaliação example: 1 nome: type: string description: Nome da avaliação example: Avaliação de perfil do candidato avaliacao: type: string description: Texto com a resposta da avaliação example: >- Perfil aderente: experiência em varejo alimentar e capital compatível com a franquia descricaoHtml: type: string description: Descrição em HTML da avaliação example:

Café torrado e moído, pacote de 500 g.

situacao: type: integer enum: - 0 - 1 - 2 description: |- Situação da avaliação. | Valor | Significado | | ----- | ----------- | | 0 | Aberto | | 1 | Positivo | | 2 | Negativo | example: 0 dtAvaliacao: type: string format: date-time description: Data em que foi realizada a avaliação (UTC ISO 8601) example: '2026-08-25T15:00:00Z' avalicaoEtapa: allOf: - $ref: '#/components/schemas/IdNomeExpansao' description: >- Etapa na qual foi criada a avaliação. Observação: o nome do campo retornado pela API é `avalicaoEtapa` (sem o segundo "a"), conforme a documentação original. IdNomeExpansao: type: object properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Site NegocioAnexo: type: object properties: id: type: integer description: Código do anexo example: 1 nome: type: string description: Nome do arquivo example: proposta-comercial.pdf dtUpload: type: string format: date-time description: Data em que foi realizado o upload do arquivo (UTC ISO 8601) example: '2026-08-20T10:05:33Z' url: type: string description: URL do anexo example: https://api.sults.com.br tamanho: type: integer description: Tamanho em bytes do anexo example: 3 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.