Skip to main content
GET
List documents
Beta Feature - This endpoint is currently in beta. The API is stable, but the schema and behavior may evolve based on feedback.

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Query Parameters

include
string

Comma-separated includes. Allowed: shipments, cargos, account, user, last_document_representation, email_submission, current_extraction (alias for last_document_representation).

sort
string

Sortable fields: document_type, added_by, created_at. Prefix with - for descending.

filter[filename]
string

Filter by filename (full-text match).

filter[reference]
string

Filter by reference token.

filter[document_types]
string

Comma-separated document types.

page[number]
integer
Required range: x >= 1
page[size]
integer
Required range: x >= 1

Response

OK

data
Document · object[]
included
(Account model · object | object | Shipment model · object | Container model · object | Document · object | Document Email Submission · object | Document Representation · object)[]

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.

meta
meta · object