List documents
List documents from the Terminal49 API with filters for shipment, container, document type, and extraction status, plus sorting and include parameters.
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Query Parameters
Comma-separated includes. Allowed: shipments, cargos, account, user, last_document_representation, email_submission, current_extraction (alias for last_document_representation).
Sortable fields: document_type, added_by, created_at. Prefix with - for descending.
Filter by filename (full-text match).
Filter by reference token.
Comma-separated document types.
x >= 1x >= 1Response
OK
- Account model
- Option 2
- Shipment model
- Container model
- Document
- Document Email Submission
- Document Representation
Pagination links. Each value is an absolute URL. self repeats the request URL as sent, including its query string and its encoding. current, first, prev, next, and last repeat the request's query parameters, with page[number] and page[size] in unencoded brackets.