Listar documentos de um cliente

GET

/documents/list/{clientId}

Lista as pastas e os arquivos do primeiro nível dos documentos do cliente, ou seja, os que não estão dentro de nenhuma pasta. Para ver o conteúdo de uma pasta, use a rota de listar conteúdo de uma pasta com o id dela. Itens na lixeira não aparecem. As pastas vêm primeiro, com kind igual a drive#folder, seguidas dos arquivos, com kind igual a drive#file; cada tipo tem os seus campos. A lista não é paginada. O perfil de permissão do usuário precisa dar acesso aos documentos de clientes; sem esse acesso, a resposta é 400 (Permissão não encontrada). Quando o acesso do perfil é restrito a algumas etiquetas, só aparecem os itens com essas etiquetas. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado). Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Documentos do primeiro nível

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Permissão não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location '/documents/list/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "id": "Xk9pQ2mW7rLz4NvB8cYt1HdJ5sFg",
            "kind": "drive#folder",
            "labels": {
                "label": "Fazenda"
            },
            "parent": "root",
            "title": "Documentos da safra 2026",
            "metadata": []
        },
        {
            "name": "cnh-titular",
            "clientId": "3f1c2a9e-5b7d-4e8a-9c0f-1a2b3c4d5e6f",
            "originalFilename": "cnh-titular.pdf",
            "labels": {
                "label": "Documentos Pessoais"
            },
            "fileExtension": "pdf",
            "parent": "root",
            "id": "Pz5wN1bQ8kTr3YcM7vLx2HgD6sJf",
            "mimeType": "application/pdf",
            "fileUrl": "https://files.example.com/cnh-titular.pdf",
            "thumbnailLink": "",
            "kind": "drive#file",
            "metadata": []
        }
    ]
}

Modificado em 2026-10-13 09:47:06

Página anterior

Mover pasta para a lixeira

Próxima página

Criar etiquetas pré-definidas de uma empresa