---
title: "List All"
method: GET
path: "/guides.json"
tags: ["Guides"]
---

# List All

`GET /guides.json`

Returns a list of guides (Shippings, Transports and Devolutions).

## Query parameters

- `api_key` string, required
- `Query Parameters` GuideQueryParamns
  - `text` string — Search for guide, client or item details.
  - `type[]` string[], required — Type(s) of document.
  - `status[]` string[], required — Status(es) of document.
  - `non_archived` boolean, required — Show non-archived documents.
  - `archived` boolean — Include archived docs
  - `loaded_at[from]` string — Date in format dd/mm/yyyy.
  - `loaded_at[to]` string — Date in format dd/mm/yyyy.
  - `page` integer — Page number
  - `per_page` integer — Items per page

## Response `200`

SUCCESS 

#### Possible values for field atcud:

* ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
* N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
* N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.

- GuideListAll
  - `guides` object[]
    - `id` integer
    - `status` string
    - `archived` boolean
    - `type` string
    - `sequence_number` string
    - `inverted_sequence_number` string — Only present once the guide has been finalized.
    - `atcud` string
    - `date` string — dd/mm/yyyy
    - `due_date` string — dd/mm/yyyy
    - `reference` string, nullable
    - `observations` string, nullable — No enforced character limit (text column).
    - `retention` string, nullable
    - `permalink` string
    - `saft_hash` string — Only present once the guide has been finalized.
    - `sum` number
    - `discount` number
    - `before_taxes` number
    - `taxes` number
    - `total` number
    - `currency` string
    - `loaded_at` string — dd/mm/yyyy. Note the single-guide endpoint returns this same field with a time component (dd/mm/yyyy HH:mm:ss).
    - `license_plate` string, nullable — 255-character limit is the database column default, not an explicit business rule.
    - `at_doc_code_id` string, nullable — Read-only. Written only by the AT gateway and never accepted on input. The 255-character limit is the database column default, not an explicit business rule.
    - `sequence_id` integer, nullable — Only present once the guide has been finalized.
    - `tax_exemption` string
    - `address_from` object
      - `country` string — Not stored on the address itself — resolved through a tax-location name lookup, falling back to Portugal.
      - `postal_code` string — 255-character limit is the database column default on the Address model, not an explicit business rule.
      - `detail` string — 255-character limit is the database column default on the Address model, not an explicit business rule. Note the API re-inserts line breaks roughly every 35 characters before storing, so an input close to 255 characters can overflow the column — keep well under the limit.
      - `city` string — 255-character limit is the database column default on the Address model, not an explicit business rule.
    - `address_to` object
      - `country` string — Not stored on the address itself — resolved through a tax-location name lookup, falling back to Portugal.
      - `postal_code` string — 255-character limit is the database column default on the Address model, not an explicit business rule.
      - `detail` string — 255-character limit is the database column default on the Address model, not an explicit business rule. Note the API re-inserts line breaks roughly every 35 characters before storing, so an input close to 255 characters can overflow the column — keep well under the limit.
      - `city` string — 255-character limit is the database column default on the Address model, not an explicit business rule.
    - `load_site` string, nullable — Flattened `address_from` (detail, postal code, city, country). Null when not set.
    - `delivery_site` string, nullable — Flattened `address_to` (detail, postal code, city, country). Null when not set.
    - `client` object — Only `id` and `name` are guaranteed; the remaining fields are present when set on the client record.
      - `id` integer
      - `name` string
      - `code` string, nullable — 255-character limit is the database column default, not an explicit business rule.
      - `email` string, nullable
      - `address` string, nullable — No enforced character limit (text column).
      - `postal_code` string, nullable — 255-character limit is the database column default, not an explicit business rule.
      - `city` string, nullable — 255-character limit is the database column default, not an explicit business rule.
      - `fiscal_id` string, nullable — 255-character limit is the database column default, not an explicit business rule.
      - `country` string — 255-character limit is the database column default, not an explicit business rule.
    - `items` object[]
      - `name` string — Maximum 60 characters. V3 rejects a longer name with HTTP 422; V2 accepts the request and silently truncates the stored value to 60 characters.
      - `description` string, nullable — Maximum 200 characters and 20 lines. V3 rejects a longer description with HTTP 422; V2 accepts the request and silently truncates the stored value to 200 characters.
      - `unit_price` string
      - `unit` string, nullable — Restricted to a fixed set of unit values rather than length-limited free text.
      - `quantity` string
      - `tax` object
        - `id` integer
        - `name` string
        - `value` number
      - `discount` number
      - `subtotal` number
      - `tax_amount` number
      - `discount_amount` number
      - `total` number
  - `pagination` Pagination
    - `total_entries` integer
    - `per_page` integer
    - `current_page` integer
    - `total_pages` integer

## Other responses

- `401` — ACCESS DENIED

---

[API](https://skmtc.dev/invoicexpress/apis/invoicexpress-api.md) · [All operations](https://skmtc.dev/invoicexpress/apis/invoicexpress-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/invoicexpress/invoicexpress-api/revisions/5b82d4eb0d9f/schema)