Get a document

Retrieve a single document record from the Terminal49 API, including classification, extraction status, and links to the file blob and last representation.

GET /documents/{id}

Get a document

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/documents/{id} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "document_type": "<string>",
      "document_type_manual": "<string>",
      "classification_notes": "<string>",
      "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"
        }
      },
      "user": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "email_submission": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "last_document_representation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "shipments": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "cargos": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    },
    "links": {
      "self": "<string>",
      "download": "<string>"
    }
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "company_name": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>"
  }
}

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

Path Parameters

id · string<uuid> · required

Query Parameters

include · string

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

Response

200

application/json

OK

data · Document · object

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

links · link · object

Show child attributes