Documents

List Documents

get/brands/{brand}/documents

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/documents
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

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

limitinteger
subjectKind'ORDER' | 'SHIPMENT' | 'PAYMENT' | 'PRODUCT' | 'PRODUCT_OPTION' | 'PRODUCT_VERSION' | 'SKU' | 'SAMPLE' | 'SAMPLE_ROUND' | 'QUOTE' | 'QUOTE_NOTE' | 'MATERIAL' | 'BOM_COMPONENT' | 'MEASUREMENT_TABLE' | 'PARTNER' | 'BRAND'
subjectKeystring
documentTypeIdstring
includeSuperseded'true' | 'false'
fileNamestring

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

mimeTypestring

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

dataValuestring

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

issuerNamestring

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

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.