> ## 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 unidades > Lista as unidades cadastradas na plataforma do SULTS. Por padrão, somente unidades com a situação **ativa** são retornadas. As unidades são **ordenadas pelo nome fantasia**. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/empresas 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: /v1/empresas: get: tags: - Unidades summary: Listar unidades description: >- Lista as unidades cadastradas na plataforma do SULTS. Por padrão, somente unidades com a situação **ativa** são retornadas. As unidades são **ordenadas pelo nome fantasia**. operationId: listarUnidades parameters: - $ref: '#/components/parameters/Start' - $ref: '#/components/parameters/Limit' - name: ativo in: query description: >- Estado da unidade. `true` busca apenas unidades ativas; `false` busca apenas unidades inativas. Padrão `true`. required: false schema: type: boolean default: true example: true responses: '200': description: Lista de unidades content: application/json: schema: type: array items: $ref: '#/components/schemas/Unidade' example: - id: 1 ativo: true razaoSocial: SULTS Tecnologia LTDA nomeFantasia: Sabor Mineiro Savassi cnpj: '12345678000190' inscricaoEstadual: Sabor Mineiro Savassi dtCadastro: '2022-01-01T12:00:00Z' dtCadastroSistema: '2022-01-01T12:00:00Z' dtInicioImplantacao: '2021-01-01T12:00:00Z' dtFimImplantacao: '2021-01-01T12:00:00Z' dtUltimaAlteracao: '2022-01-01T12:00:00Z' dtInauguracao: '2021-01-01T12:00:00Z' situacaoId: 1 dtInativacao: '2022-01-01T12:00:00Z' dtInativacaoSistema: '2022-01-01T12:00:00Z' anotacaoAtencao: Unidade em período de implantação. inativacaoPessoa: id: 99 nome: Ana Ribeiro endereco: uf: MG cidade: Uberaba complemento: '' numero: 15 bairro: Centro latitude: '0' cep: '38026000' rua: Avenida Leopoldino de Oliveira longitude: '0' email: - operacoes@sabormineiro.com.br telefone: - '3432125000' celular: - '34988776655' receitaFederal: dtAberturaRF: '2020-01-01T12:00:00Z' naturezaJuridicaRF: 206-2 - Sociedade Empresária Limitada situacaoEspecialRF: '' dtSituacaoEspecialRF: '2020-01-01T12:00:00Z' capitalSocialRF: 100000000 motivoSituacaoEspecialRF: '' situacaoRF: ATIVA campoAdicional: - id: 1 label: Rede Sabor Mineiro valor: '' grupo: - id: 1 nome: Franquias Sudeste categoria: id: 2 nome: Regional formulario: - id: 1 nome: Financeiro campoAdicional: - id: 98 label: valor minimo valor: '4500.45' grupo: nome: Cobrança id: 9 '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: Unidade: type: object properties: id: type: integer description: Código da unidade example: 1 ativo: type: boolean description: '`true`: unidade ativa. `false`: unidade inativa.' example: true razaoSocial: type: string description: Razão Social da unidade example: SULTS Tecnologia LTDA nomeFantasia: type: string description: Nome Fantasia da unidade example: Sabor Mineiro Savassi cnpj: type: string description: CNPJ da unidade (retornado sem máscara) example: '12345678000190' inscricaoEstadual: type: string description: Inscrição Estadual da unidade example: '0623079040081' dtCadastro: type: string format: date-time description: Data em que a unidade foi criada example: '2026-07-15T14:32:08Z' dtCadastroSistema: type: string format: date-time description: Data em que a unidade foi cadastrada no sistema example: '2026-07-15T14:32:08Z' dtInicioImplantacao: type: string format: date-time description: Data em que a unidade iniciou a implantação example: '2026-07-20T12:00:00Z' dtFimImplantacao: type: string format: date-time description: Data em que a unidade finalizou a implantação example: '2026-09-30T21:00:00Z' dtUltimaAlteracao: type: string format: date-time description: Data da última atualização no cadastro da unidade example: '2026-10-06T16:47:21Z' dtInauguracao: type: string format: date-time description: Data em que a unidade foi inaugurada example: '2026-10-03T12:00:00Z' situacaoId: type: integer description: Código da situação da unidade example: 5 dtInativacao: type: string format: date-time description: Data em que a unidade foi inativada example: '2026-12-18T21:00:00Z' dtInativacaoSistema: type: string format: date-time description: Data em que a unidade foi inativada no sistema example: '2026-12-18T21:03:10Z' anotacaoAtencao: type: string description: Nota de atenção da unidade example: Unidade em período de implantação. inativacaoPessoa: allOf: - $ref: '#/components/schemas/Pessoa' description: Pessoa que inativou a unidade no sistema endereco: $ref: '#/components/schemas/Endereco' email: type: array items: type: string example: operacoes@sabormineiro.com.br description: Lista de e-mails da unidade telefone: type: array items: type: string example: '3432125000' description: Lista de telefones da unidade (sem máscara) celular: type: array items: type: string example: '34988776655' description: Lista de celulares da unidade (sem máscara) receitaFederal: $ref: '#/components/schemas/ReceitaFederal' campoAdicional: type: array items: $ref: '#/components/schemas/CampoAdicional' description: Campos adicionais da unidade grupo: type: array items: $ref: '#/components/schemas/Grupo' description: Grupos aos quais a unidade pertence formulario: type: array items: $ref: '#/components/schemas/FormularioPersonalizado' description: Formulários personalizados da unidade Pessoa: type: object properties: id: type: integer description: Código da pessoa example: 1 nome: type: string description: Nome da pessoa example: Ana Ribeiro Endereco: type: object properties: uf: type: string description: Estado da unidade example: MG cidade: type: string description: Cidade da unidade example: Uberaba rua: type: string description: Rua da unidade example: Avenida Leopoldino de Oliveira numero: type: integer description: Número da rua da unidade example: 3200 complemento: type: string description: Complemento do endereço da unidade example: Sala 12 bairro: type: string description: Bairro da unidade example: Centro cep: type: string description: CEP da unidade (sem máscara) example: '38026000' latitude: type: string description: Latitude da unidade example: '-19.7472' longitude: type: string description: Longitude da unidade example: '-47.9381' ReceitaFederal: type: object properties: dtAberturaRF: type: string format: date-time description: Data de abertura da unidade na Receita Federal example: '2019-02-11T00:00:00Z' naturezaJuridicaRF: type: string description: Natureza jurídica da unidade example: 206-2 - Sociedade Empresária Limitada capitalSocialRF: type: number description: Capital social da unidade na Receita Federal example: 1 situacaoRF: type: string description: Situação na Receita Federal example: ATIVA situacaoEspecialRF: type: string description: Situação especial da unidade na Receita Federal example: '' motivoSituacaoEspecialRF: type: string description: Motivo da situação especial na Receita Federal example: '' dtSituacaoEspecialRF: type: string format: date-time description: Data de cadastro da situação especial na Receita Federal example: '2024-05-02T00:00:00Z' CampoAdicional: type: object properties: id: type: integer description: Código do campo adicional example: 1 label: type: string description: Nome do campo adicional example: Rede Sabor Mineiro valor: description: >- Valor do campo adicional. Observação: o tipo do valor pode variar (dinâmico). grupo: type: object description: 'Grupo ao qual o campo adicional pertence. Observação: pode ser nulo.' properties: id: type: integer description: Código do grupo example: 1 nome: type: string description: Nome do grupo example: Cobrança Grupo: type: object properties: id: type: integer description: Código do grupo ao qual a unidade pertence example: 1 nome: type: string description: Nome do grupo example: Franquias Sudeste categoria: type: object description: Categoria à qual o grupo da unidade pertence properties: id: type: integer description: Código da categoria example: 1 nome: type: string description: Nome da categoria example: Regional FormularioPersonalizado: type: object properties: id: type: integer description: Código do formulário da unidade example: 1 nome: type: string description: Nome do formulário example: Financeiro campoAdicional: type: array items: $ref: '#/components/schemas/CampoAdicional' description: Lista de campos adicionais do formulário personalizado 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.