Skip to main content
GET
List business documents

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.

Example:

"da-DK, da;q=0.9, en;q=0.8"

Request-ID
string

Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

teamUuid
string<uuid>
required

Team uuid. All resources are scoped to this team.

Query Parameters

source_type
string

Producing resource type, e.g. shipment, report or manifest.

source_uuid
string<uuid>

Producing resource UUID; use together with source_type.

type
enum<string>

Content kind; combined files may match multiple kinds. Kind of content a generated document can contain

Available options:
label,
customs_declaration,
commercial_invoice,
proforma_invoice,
packing_list,
report,
manifest
format
enum<string>

Filter by document file format. Business-document file format. XLSX is a report format; direct printing is limited by the print service and selected printer.

Available options:
pdf,
zpl,
png,
xlsx
cursor
string

Opaque cursor returned by this endpoint. Omit it for the first page. Keep all filters, sort order and per_page unchanged within a page sequence. For tracking polls, use the documented resume_cursor once next is null.

Minimum string length: 1
per_page
integer
default:100

Maximum number of resources per page.

Required range: 1 <= x <= 1000

Response

Document metadata and signed links.

data
object[]
required

Navigation links for a cursor-paginated collection. Follow next or prev with GET; returned URLs preserve the selected filters, sort order, page size and sync boundary where applicable.

meta
object
required