List documents
curl --request GET \
--url https://api.terminal49.com/v2/documents \
--header 'Authorization: <api-key>'import requests
url = "https://api.terminal49.com/v2/documents"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.terminal49.com/v2/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.terminal49.com/v2/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.terminal49.com/v2/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.terminal49.com/v2/documents")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.terminal49.com/v2/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "document",
"attributes": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"document_type": "<string>",
"document_type_manual": "<string>",
"classification_notes": "<string>",
"source": "upload",
"file_name": "<string>",
"file_content_type": "<string>",
"file_size_bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"account": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account"
}
},
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "user"
}
},
"email_submission": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email_submission"
}
},
"last_document_representation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "document_representation"
}
},
"shipments": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "shipment"
}
]
},
"cargos": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "container"
}
]
}
},
"links": {
"self": "<string>",
"download": "<string>"
}
}
],
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account",
"attributes": {
"company_name": "<string>"
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
}
}{
"errors": [
{
"status": "400",
"title": "Bad Request",
"detail": "invalid_relation is not specified as a relationship on V2::DocumentSerializer",
"source": {
"parameter": "include"
}
}
]
}{
"errors": [
{
"status": "401",
"title": "Unauthorized",
"detail": "Invalid or missing API token."
}
]
}Documents
List documents
List documents from the Terminal49 API with filters for shipment, container, document type, and extraction status, plus sorting and include parameters.
GET
/
documents
List documents
curl --request GET \
--url https://api.terminal49.com/v2/documents \
--header 'Authorization: <api-key>'import requests
url = "https://api.terminal49.com/v2/documents"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.terminal49.com/v2/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.terminal49.com/v2/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.terminal49.com/v2/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.terminal49.com/v2/documents")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.terminal49.com/v2/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "document",
"attributes": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"document_type": "<string>",
"document_type_manual": "<string>",
"classification_notes": "<string>",
"source": "upload",
"file_name": "<string>",
"file_content_type": "<string>",
"file_size_bytes": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"account": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account"
}
},
"user": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "user"
}
},
"email_submission": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email_submission"
}
},
"last_document_representation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "document_representation"
}
},
"shipments": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "shipment"
}
]
},
"cargos": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "container"
}
]
}
},
"links": {
"self": "<string>",
"download": "<string>"
}
}
],
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account",
"attributes": {
"company_name": "<string>"
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
}
}{
"errors": [
{
"status": "400",
"title": "Bad Request",
"detail": "invalid_relation is not specified as a relationship on V2::DocumentSerializer",
"source": {
"parameter": "include"
}
}
]
}{
"errors": [
{
"status": "401",
"title": "Unauthorized",
"detail": "Invalid or missing API token."
}
]
}Beta Feature - This endpoint is currently in beta. The API is stable, but the schema and behavior may evolve based on feedback.
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.
Required range:
x >= 1Required range:
x >= 1Response
OK
Show child attributes
Show child attributes
included
(Account model · object | any | Shipment model · object | Container model · object | Document · object | Document Email Submission · object | Document Representation · object)[]
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?