Skip to main content
GET
List Documents

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

Query Parameters

cursor
string

Opaque nextCursor from the same collection and filters. Omit on the first request.

limit
integer
default:25
Required range: 1 <= x <= 100
subjectKind
enum<string>
Available options:
ORDER,
SHIPMENT,
PAYMENT,
PRODUCT,
PRODUCT_OPTION,
PRODUCT_VERSION,
SKU,
SAMPLE,
SAMPLE_ROUND,
QUOTE,
QUOTE_NOTE,
MATERIAL,
BOM_COMPONENT,
MEASUREMENT_TABLE,
PARTNER,
BRAND
subjectKey
string
Required string length: 1 - 255
documentTypeId
string
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
includeSuperseded
enum<string>
Available options:
true,
false
fileName
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
mimeType
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
dataValue
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255
issuerName
string

Exact, case-sensitive match. Spaces and punctuation are literal.

Required string length: 1 - 255

Response

One page. totalItems counts the full filtered set; nextCursor null means exhausted.

items
object[]
required
nextCursor
string | null
required
totalItems
integer
required
Required range: 0 <= x <= 9007199254740991