API Zen 2 - V2
  1. Gerenciador de Empresas
API Zen 2 - V2
  • API Zen 2 - V2
    • Raiz
      • Arquivos
        • Insere um anexo de documento no storage.
      • Autenticação
        • Realiza o login de um usuário na API utilizando e-mail e senha.
      • E-Doc
        • Consultar Pastas.
        • 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
        • Consulta informações sobre os departamentos com base nos filtros fornecidos.
          GET
        • Edição de uma empresa existente no sistema.
          PUT
        • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
          GET
        • Consulta os perfis de acesso com base nos filtros fornecidos.
          GET
      • Gerenciador de Usuários
        • Criação de Usuário Empresa.
        • Consulta de Usuário(s) Empresa.
        • Vincular Usuário a Empresa(s).
        • Criação de Usuário Escritório.
        • Consulta de Usuário(s) Escritório.
      • 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.
      • Q-Drive NFS-e
        • Realiza a importação de Notas Fiscais de Serviço Eletrônica (NFS-e).
    • Esquemas
      • Schemas
        • AtivoInativoEnum
        • CadastroDocumentoEdocApiModel
        • CadastroDocumentoQcolaboreApiModel
        • ConsultaEmpresaModel
        • ConsultaUsuarioEmpresaModel
        • ConsultaUsuarioEscritorioModel
        • ConsultarPastasApiModel_EdocSubpastaApiModel
        • ConsultarPastasApiModel_QColaboreSubpastaApiModel
        • DFe_Classes_Flags_TipoAmbiente
        • DepartamentoRetornoApiModel
        • DownloadArquivoRetornoApiModel
        • EditarEmpresaApiModel
        • EdocSubpastaApiModel
        • EmpresaCadastroDocumentoApi
        • EmpresaRetornoApiModel
        • EnderecoApiModel
        • EnderecoEmpresa
        • GrupoEmpresaRetornoApiModel
        • InformacoesAdicionaisApiModel
        • InformacoesAdicionaisEmpresa
        • InserirEmpresaApiModel
        • InserirUsuarioEscritorioApiModel
        • LoginRetornoApi
        • LoginUsuarioApiV2Model
        • PerfilAcessoRetornoApiModel
        • PerfilTareffaApi
        • QColaboreSubpastaApiModel
        • QuestorZen_Application_Edoc_Models_CadastroDocumentoQcolaboreApiModel_EmpresaCadastroDocumentoApi
        • RegimeTributarioEnum
        • ResultadoImportacao
        • ResumoArquivoImportacao
        • 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
        • TipoFone
        • TipoInscricao
        • UsuarioDestino
        • UsuarioDestinoEdoc
        • UsuarioEmpresaApiModel
        • VinculoEmpresaUsuarioApiV2Model
  1. Gerenciador de Empresas

Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.

GET
/v2/Empresas/GrupoEmpresas
Este endpoint permite consultar informações sobre os grupos de empresas cadastradas no sistema.
O parâmetro TotalRegistros pode ser utilizado para limitar o número de registros retornados.
A consulta retorna um conjunto de grupos de empresas que atendem aos filtros fornecidos.
Validações:
Verifica se o número total de registros solicitado não ultrapassa 500.
Respostas:
Sucesso: Retorna a lista de grupos de empresas conforme os filtros aplicados.
Falhas: Detalha os erros, como número de registros excedente ou falhas na validação dos filtros.
Exemplo de Requisição (GET com parâmetros na URL):
Valores e Descrições do Enum AtivoInativoEnum:
ValorDescrição
1Ativo
2Inativo
Exemplo de Resposta de Sucesso (200 - OK):
{
  "sucesso": true,
  "mensagens": "Consulta realizada com sucesso",
  "dados": [
    {
      "Id": 12345,
      "NomeGrupo": "Grupo A",
      "Descricao": "Descrição do Grupo A"
    },
    {
      "Id": 12346,
      "NomeGrupo": "Grupo B",
      "Descricao": "Descrição do Grupo B"
    }
  ]
}
Exemplo de Resposta de Erro (400 - Bad Request):
{
  "sucesso": false,
  "mensagens": "Erro de validação nos dados fornecidos",
  "dados": null
}

Requisição

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

Respostas

🟢200OK
application/json
Consulta realizada com sucesso. Retorna a lista de grupos de empresas.
Body

🟠400Solicitação incorreta
🔴500Erro interno do servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/Empresas/GrupoEmpresas?IdsGrupo&Status&TotalRegistros&Pagina' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "sucesso": true,
    "mensagens": "string",
    "dados": {
        "id": 0,
        "nome": "string",
        "status": true
    }
}
Modificado em 2025-09-24 14:39:45
Página anterior
Edição de uma empresa existente no sistema.
Próxima página
Consulta os perfis de acesso com base nos filtros fornecidos.
Built with