---
title: "Document index"
method: GET
path: "/api/v1/documents"
tags: ["documents"]
---

# Document index

`GET /api/v1/documents`

## Request

- Base URL: `https://www.foxnfe.com.br`
- URL: `https://www.foxnfe.com.br/api/v1/documents`
- Auth: HTTP bearer

## Query parameters

- `date_from` string, date, required
- `date_to` string, date, required: Deve ser posterior ou igual a date_from.
- `tipos` string[]
- `ambiente` 1 | 2 | null, nullable
- `origin` 'emitida' | 'recebida' | 'importada' | 'null', nullable
- `status` 'draft' | 'pending' | 'processing' | 'authorized' | 'rejected' | 'denied' | 'canceled' | 'contingency' | 'substituted' | 'recebida' | 'importada' | 'null', nullable
- `participante` string, nullable
- `valor_min` string, nullable
- `valor_max` string, nullable
- `sort` 'date' | 'valor' | 'numero'
- `sort_direction` 'asc' | 'desc'
- `page` integer
- `per_page` integer

## Response `200`

Resposta implementada pelo controlador.

- object
  - `data` unknown
  - `meta` unknown
  - `totals` unknown

---

[API](https://skmtc.dev/foxnfe/apis/fox-nf-e-api.md) · [All operations](https://skmtc.dev/foxnfe/apis/fox-nf-e-api/llms.txt) · [OpenAPI document](https://skmtc.dev/foxnfe/apis/fox-nf-e-api/revisions/8820a6e016b0?raw)