API Zen 2 - V2
  1. Gerenciador de Empresas
API Zen 2 - V2
  • Raiz
    • Autenticação
      • Realiza o login de um usuário na API utilizando e-mail e senha.
    • E-Doc
      • Consultar Pastas.
      • Insere um anexo de documento no storage.
      • Cadastro de Documento.
      • Cancelar Documento.
    • Gerenciador de Empresas
      • Consulta informações sobre as empresas com base nos filtros fornecidos.
        GET
      • Cadastro de uma nova empresa no sistema.
        POST
      • Edição de uma empresa existente no sistema.
        PUT
      • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
        GET
    • Q-Colabore
      • Consultar Pastas.
      • Cancelar Documento.
      • Cadastro de Documento.
    • Q-Drive Documentos Fiscais
      • Realiza a importação de documentos fiscais, incluindo NF-e, CT-e, CT-e OS, NFC-e, CF-e e seus respectivos eventos.
      • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
  • Esquemas
    • Schemas
      • AtivoInativoEnum
      • CadastroDocumentoEdocApiModel
      • CadastroDocumentoQcolaboreApiModel
      • EditarEmpresaApiModel
      • InserirEmpresaApiModel
      • InserirUsuarioEscritorioApiModel
      • InserirUsuarioEscritorioComSenhaApiModel
      • LoginUsuarioApiV2Model
      • RetornoApi
      • RetornoApi_ConsultaUsuarioEmpresaModel
      • RetornoApi_DepartamentoRetornoApiModel
      • RetornoApi_EmpresaRetornoApiModel
      • RetornoApi_GrupoEmpresaRetornoApiModel
      • RetornoApi_IEnumerable_ConsultaUsuarioEscritorioModel
      • RetornoApi_IEnumerable_ConsultarPastasApiModel_EdocSubpastaApiModel
      • RetornoApi_IEnumerable_ConsultarPastasApiModel_QColaboreSubpastaApiModel
      • RetornoApi_IEnumerable_DownloadArquivoRetornoApiModel
      • RetornoApi_Int64
      • RetornoApi_LoginRetornoApi
      • RetornoApi_Object
      • RetornoApi_PerfilAcessoRetornoApiModel
      • RetornoApi_ResultadoImportacao
      • RetornoApi_String
      • TipoAmbiente
      • TipoDepartamento
      • TipoDocumentoFiscal
      • UsuarioEmpresaApiModel
      • VinculoEmpresaUsuarioApiV2Model
  1. Gerenciador de Empresas

Consulta informações sobre as empresas com base nos filtros fornecidos.

GET
/v2/Empresas
Este endpoint permite consultar as empresas no sistema com base em parâmetros de filtro fornecidos no modelo.
Ele valida a quantidade de registros solicitados e retorna as empresas correspondentes.
Validações:
Verifica se o número total de registros solicitado não ultrapassa 500.
Exemplo de Requisição:
Valores e Descrições do Enum AtivoInativoEnum:
ValorDescrição
1Ativo
2Inativo
Exemplo de resposta (sucesso):
{
  "status": true,
  "message": "Ok",
  "data": [
    {
      "IdEmpresa": 12345,
      "TipoInscricao": "CNPJ",
      "InscricaoFederal": "12345678000123",
      "NomeEmpresa": "Empresa Exemplo",
      "Status": "1",
      "Endereco": {
        "CEP": "12345678",
        "Estado": "SP",
        "CodigoIbge": "1234567",
        "Municipio": "São Paulo",
        "TipoLogradouro": "Rua",
        "Endereco": "Exemplo",
        "Numero": 100,
        "Bairro": "Centro",
        "Complemento": "Sala 10"
      },
      "InformacoesAdicionais": {
        "RazaoSocial": "Razão Social Exemplo",
        "NomeFantasia": "Nome Fantasia Exemplo",
        "InscricaoMunicipal": "123456",
        "CNAE": "12345678",
        "DescricaoCNAE": "Comércio Varejista",
        "RegimeTributario": 1,
        "SocioPrincipal": "João Silva",
        "CpfSocioPrincipal": "12345678901",
        "Telefone": "1123456789",
        "TipoTelefone": "4",
        "Email": "contato@empresa.com"
      }
    }
  ]
}
Exemplo de resposta (erro):
{
  "status": false,
  "message": "Total de registros não pode ser superior a 500",
    "dados": null
}

Requisição

Authorization
API Key
Adicionar parâmetro em header
Authorization
Exemplo:
Authorization: ********************
or
Parâmetros Query

Respostas

🟢200OK
application/json
Retorna a lista de empresas conforme o filtro informado.
Body

🟠400Solicitação Incorreta
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/Empresas' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {}
}
Modificado em 2025-08-27 13:38:15
Página anterior
Cancelar Documento.
Próxima página
Cadastro de uma nova empresa no sistema.
Built with