Listar unidades - SULTS Developers

GET

empresas

Listar unidades

curl --request GET \
  --url https://api.sults.com.br/v1/empresas \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/v1/empresas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/v1/empresas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/v1/empresas");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "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
            }
          }
        ]
      }
    ]
  }
]

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

Authorizations

Authorization

string

header

required

Token gerado através do sistema do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

start

integer

default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia ou até atingir totalPage.

Required range: x >= 0

limit

integer

default:100

Quantidade de registros por página. O máximo aceito pela API é 100.

Required range: 1 <= x <= 100

ativo

boolean

default:true

Estado da unidade. true busca apenas unidades ativas; false busca apenas unidades inativas. Padrão true.

Response

Lista de unidades

integer

Código da unidade

Example:

1

ativo

boolean

true: unidade ativa. false: unidade inativa.

Example:

true

Razão Social da unidade

Example:

"SULTS Tecnologia LTDA"

nomeFantasia

string

Nome Fantasia da unidade

Example:

"Sabor Mineiro Savassi"

cnpj

string

CNPJ da unidade (retornado sem máscara)

Example:

"12345678000190"

inscricaoEstadual

string

Inscrição Estadual da unidade

Example:

"0623079040081"

dtCadastro

string<date-time>

Data em que a unidade foi criada

Example:

"2026-07-15T14:32:08Z"

dtCadastroSistema

string<date-time>

Data em que a unidade foi cadastrada no sistema

Example:

"2026-07-15T14:32:08Z"

dtInicioImplantacao

string<date-time>

Data em que a unidade iniciou a implantação

Example:

"2026-07-20T12:00:00Z"

dtFimImplantacao

string<date-time>

Data em que a unidade finalizou a implantação

Example:

"2026-09-30T21:00:00Z"

dtUltimaAlteracao

string<date-time>

Data da última atualização no cadastro da unidade

Example:

"2026-10-06T16:47:21Z"

dtInauguracao

string<date-time>

Data em que a unidade foi inaugurada

Example:

"2026-10-03T12:00:00Z"

situacaoId

integer

Código da situação da unidade

Example:

5

dtInativacao

string<date-time>

Data em que a unidade foi inativada

Example:

"2026-12-18T21:00:00Z"

dtInativacaoSistema

string<date-time>

Data em que a unidade foi inativada no sistema

Example:

"2026-12-18T21:03:10Z"

anotacaoAtencao

string

Nota de atenção da unidade

Example:

"Unidade em período de implantação."

inativacaoPessoa

object

Pessoa que inativou a unidade no sistema

Show child attributes

endereco

object

Show child attributes

string[]

Lista de e-mails da unidade

telefone

string[]

Lista de telefones da unidade (sem máscara)

celular

string[]

Lista de celulares da unidade (sem máscara)

receitaFederal

object

Show child attributes

campoAdicional

object[]

Campos adicionais da unidade

Show child attributes

grupo

object[]

Grupos aos quais a unidade pertence

Show child attributes

formulario

object[]

Formulários personalizados da unidade

Show child attributes

Listar unidades

curl --request GET \
  --url https://api.sults.com.br/v1/empresas \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/v1/empresas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/v1/empresas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/v1/empresas");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "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
            }
          }
        ]
      }
    ]
  }
]

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}

<string>

{
  "error": "Campo responsavel não pode ser vazio ou nulo."
}