# List Guides (POST) Same as GET /api/v3/guides, with the filters and pagination options sent in a JSON body instead of the query string. Useful when the filters (for example long id or client_id lists) do not fit in a URL. Returns the same response. Endpoint: POST /api/v3/guides Version: 3.1.0 Security: apiKeyAuth ## Query parameters: - `api_key` (string, required) Your API Key. Example: "YOUR_API_KEY" ## Request fields (application/json): - `language` (string) Language of the response Example: "pt" - `items_per_page` (integer) Number of items per page Example: 10 - `page` (integer) Page number Example: 1 - `id` (array) Filter by one or more document ids Example: ["541897"] - `except_id` (array) Exclude these document ids Example: ["541897"] - `sort` (string) Field to sort by Example: "document_type" - `sort_order` (string) Order of sorting (asc/desc) Enum: "asc", "desc" - `text` (string) Text to search for Example: "asdasdwqe" - `non_archived` (boolean) Filter for non-archived items Example: true - `archived` (boolean) Filter for archived items - `reference` (string) Reference identifier Example: "123asd" - `show_iva` (boolean) Show IVA Example: true - `type` (array) Document type filter Example: ["invoice"] - `status` (array) Status filter Example: ["draft"] - `client_id` (array) Client id filter Example: ["541897"] - `plugin` (array) Plugin filter Example: ["541897123-asdasdasd-zxcas123"] - `serie_name` (array) Serie name filter Example: ["SerieA"] - `date[from]` (string) Document date range start Example: "2026-04-27" - `date[to]` (string) Document date range end Example: "2026-04-27" - `loaded_at[from]` (string) Loaded-at range start Example: "2026-04-27" - `loaded_at[to]` (string) Loaded-at range end Example: "2026-04-27" - `total_before_taxes[from]` (number) Total before taxes range start - `total_before_taxes[to]` (number) Total before taxes range end - `total_with_taxes[from]` (number) Total with taxes range start - `total_with_taxes[to]` (number) Total with taxes range end ## Response 200 fields (application/json): - `guides` (array) - `guides.id` (integer) Example: 541674 - `guides.sequence_number` (string) Example: "serie_name/4" - `guides.sequence` (string) Example: "serie_name" - `guides.type` (string) Example: "Transport" - `guides.license_plate` (string,null) Always present; null when not set. 255-character DB default; not explicitly validated. Example: "AB-CD-12" - `guides.status` (string) Raw stored status. A finalized guide is sent here, while show and change-state return it as final. Enum: "draft", "sent", "canceled", "second_copy" - `guides.archived` (boolean) - `guides.client_name` (string) Example: "John Doe" - `guides.reference` (string,null) The document's free-text reference, the same value the reference filter searches. null when the document has none. Example: "PO-1234" - `guides.date` (string) Example: "2023-01-03 00:00:00 +0000" - `guides.loaded_at` (string) Example: "2023-01-03 12:00:00 +0000" - `guides.total` (number) Example: 6.15 - `guides.total_before_taxes` (number) Example: 5 - `guides.token` (string,null) Public document token; null when the guide has none. Example: "541674bbfcdd182143fe2747524df08ab1367ef8255010" - `totals` (object) - `totals.count` (integer) Example: 44 - `totals.pages` (integer) count / per_page rounded to the nearest integer, not rounded up — it can be one less than the real number of pages (e.g. 44 guides at 10 per page gives 4, although page 5 exists). Use count to decide whether more pages exist. Example: 4 - `totals.statuses` (array) Distinct statuses of the guides on the current page only — not of the whole filtered result set. Example: ["canceled"] ## Response 401 fields (application/json): - `errors` (array) Example: [{"error":"Authentication Error"}] - `errors.error` (string) ## Response 500 fields (application/json): - `errors` (array) Example: [{"error":"An unexpected error occurred"}] - `errors.error` (string) ## Response 503 fields (application/json): - `errors` (array) Example: [{"error":"An unexpected error occurred"}] - `errors.error` (string)