API Zen 2 - V2
  1. Q-Colabore
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.
      • Cadastro de uma nova empresa no sistema.
      • Edição de uma empresa existente no sistema.
      • Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
    • Q-Colabore
      • Consultar Pastas.
        GET
      • Cancelar Documento.
        DELETE
      • Cadastro de Documento.
        POST
    • 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. Q-Colabore

Consultar Pastas.

GET
/v2/Qcolabore/Pastas
Este endpoint realiza o Consultar Pastas (Departamentos) disponíveis para documentos no QColabore.
Validações:
Será listado apenas Pastas disponíveis para o módulo QColabore.
Exemplo de Requisição (Rota):
Exemplo de Resposta de Sucesso (200 - OK):
{
    "sucesso": true,
    "mensagens": "Pastas encontradas com sucesso.",
    "dados": [
        {
            "Id": "12345",
            "Nome": "Departamento A"
        },
        {
            "Id": "67890",
            "Nome": "Departamento B"
        }
    ]
}
Exemplo de Resposta de Erro (403 - Forbidden):
{
    "sucesso": false,
    "mensagens": "Usuário não tem permissão para acessar as pastas.",
    "dados": null
}

Requisição

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

Respostas

🟢200OK
application/json
Sucesso. Retorna a lista de pastas encontradas.
Body

🟠403Proibido
🔴500Erro do Servidor
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/Qcolabore/Pastas' \
--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
Consulta os grupos de empresas existentes no sistema, com base nos filtros fornecidos.
Próxima página
Cancelar Documento.
Built with