List a deal's documents (metadata)

GET

/api/integrations/v1/deals/{id}/documents

curl --request GET \
  --url https://app.quatlasglobal.com/api/integrations/v1/deals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/documents \
  --header 'Authorization: Bearer <token>'

Requires the documents:read scope. The current version of each document in the deal’s vault, newest first: category, file name, when and by which side it was uploaded, and its malware scan status. Never the file itself: download a Clean one through /documents/{id}/download.

Authorizations

• IntegrationKey
• IntegrationOAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

dealId

required

string format: uuid

dealNumber

The deal’s business number (DEAL-206447).

null | string

items

required

Array<object>

object

category

required

The document’s category (CommercialInvoice, PackingList, BillOfLading, …).

string

dealId

required

string format: uuid

fileName

required

string

id

required

string format: uuid

scanStatus

required

Malware scan: Clean, Pending, Infected or Failed. Only a Clean document can be downloaded.

string

uploadedAt

required

string format: date-time

uploadedBySide

required

Which side uploaded it: Shipper or Carrier.

string

livemode

required

boolean

Example^generated

{
  "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "dealNumber": "example",
  "items": [
    {
      "category": "example",
      "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "fileName": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "scanStatus": "example",
      "uploadedAt": "2026-04-15T12:00:00Z",
      "uploadedBySide": "example"
    }
  ],
  "livemode": true
}

401

Unauthorized

Media typeapplication/problem+json

object

detail

null | string

instance

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

title

null | string

type

null | string

Example^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Forbidden

Media typeapplication/problem+json

object

detail

null | string

instance

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

title

null | string

type

null | string

Example^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Not Found

Media typeapplication/problem+json

object

detail

null | string

instance

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

title

null | string

type

null | string

Example^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Too Many Requests

Media typeapplication/problem+json

object

detail

null | string

instance

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

title

null | string

type

null | string

Example^generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}