Consultar Pastas.

GET

/v2/EDoc/Pastas

Este endpoint realiza o Consultar Pastas (Departamentos) disponíveis para documentos no Edoc.

Validações:

Será listado apenas Pastas disponíveis para o módulo Edoc.

Exemplo de Requisição:

Exemplo de Resposta de Sucesso (200 - OK):

{
    "sucesso": true,
    "mensagens": "",
    "dados": [ ... ]
}

Exemplo de Resposta de Erro (403 - Permissão Negada):

{
    "sucesso": false,
    "mensagens": "Usuário sem permissão para acessar as pastas.",
    "dados": null
}

Exemplo de Resposta de Erro (500 - Erro Interno):

{
    "sucesso": false,
    "mensagens": "Erro interno ao processar a consulta das pastas.",
    "dados": null
}

Requisição

Authorization

API Key

Adicionar parâmetro em header

Authorization

Exemplo:

Authorization: ********************

Respostas

🟢200OK

application/json

Success

Body

🟠403Permissão insuficiente

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/EDoc/Pastas' \
--header 'Authorization: <api-key>'

Response Example

200 - Exemplo 1

{
    "sucesso": true,
    "mensagens": "string",
    "dados": [
        {
            "modulo": "string",
            "pasta": "string",
            "ativo": true,
            "subpastas": [
                {
                    "id": 0,
                    "subpasta": "string",
                    "dataVencimento": true,
                    "dataCompetencia": true,
                    "valor": true,
                    "ativo": true
                }
            ]
        }
    ]
}

Modificado em 2025-09-24 14:39:45

Página anterior

Realiza o login de um usuário na API utilizando e-mail e senha.

Próxima página

Cadastro de Documento.