> For the complete documentation index, see [llms.txt](https://docs-agents-api.boolfy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-agents-api.boolfy.com/documents/list.md).

# List

Para consultar el listado de documentos podemos generar la siguiente solicitud con el archivo `payload.json`:

```
curl "https://agents.boolfy.com/api/documents/list" \ 
    -H "Authorization: Bearer BOOLFY_BEARER_KEY" \
    -H "Content-Type: application/json" \
    -d @payload.json
```

El archivo `payload.json` debe tener el siguiente formato:

```json
{
    "Agent": "Facturas",
    "FromDate": "2024/01/01",
    "ToDate": "2024/01/31",
    "State": "Finished",
    "DocumentState": "Approved",
    "FileFormat": "JSON"
}
```

Detallamos en forma completa los campos de la solicitud:

<table><thead><tr><th width="221">Campo</th><th>Descripción</th></tr></thead><tbody><tr><td>Agent</td><td>Obligatorio. Especifica el nombre del agente IA de Boolfy para el documento. </td></tr><tr><td>FromDate</td><td>Obligatorio. Especifica la fecha desde del listado en formato: yyyy\mm\dd.</td></tr><tr><td>ToDate</td><td>Obligatorio. Especifica la fecha hasta del listado en formato: yyyy\mm\dd.</td></tr><tr><td>State</td><td>Opcional. Es el estado del <a href="/pages/VirGu75OHC7cdnnmO6aP#estados-del-proceso">Proceso del documento</a>. Si no se especifica se asume Finished. Para consultar documentos enviados, especificar Sended. </td></tr><tr><td>DocumentState</td><td>Opcional. Es el <a href="/pages/VirGu75OHC7cdnnmO6aP#estados-de-revision">Estado de revisión</a>. Si no se especifica, este dato no filtra los documentos a obtener.</td></tr><tr><td>FileFormat</td><td>Opcional. Es el formato del campo response en la respuesta. Sus valores posibles son: JSON, CSV o XML. Si no se especifica, se asume: JSON.</td></tr><tr><td>Source</td><td>Opcional. Especifica como fue cargado el documento. Los valores posibles se detallan en <a href="#codigos-de-origen">Códigos de origen</a>.</td></tr></tbody></table>

### Respuesta

La respuesta exitosa para la consulta es:

```json
{
    "code": 200,
    "msg": null,
    "response": "[{\"Identifier\":\"5a37b2ab...",\"Pages\":2,\"Filename\":\"...},{...}]"
}
```

El campo Response es un listado de documentos. Los campos de este listado pueden consultarse en el método [GetInfo](/documents/getinfo.md#respuesta).

## Códigos de origen

A continuación detallamos los códigos de origen para los documentos.

<table><thead><tr><th width="152">Code</th><th width="599.4000244140625">Nombre</th></tr></thead><tbody><tr><td>Manual</td><td>Cuando un usuario sube de forma manual el documento</td></tr><tr><td>API</td><td>Cuando se recibe por API</td></tr><tr><td>Email</td><td>Cuando se descarga automáticamente desde una dirección de email</td></tr><tr><td>FTP</td><td>Cuando se descarga automáticamente desde un acceso FTP</td></tr><tr><td>Portal</td><td>Cuando se sube desde el Portal de proveedores</td></tr><tr><td>Drive</td><td>Cuando se descarga automáticamente desde Google o Microsoft Drive</td></tr></tbody></table>