API Reference
Read Documents
List and retrieve documents shared with your organisation across all consignments.
Use these endpoints to access documents attached to consignments visible to your organisation. Documents are always attached to a consignment — these endpoints let you query them across all consignments at once, or retrieve a single document directly.
Every request requires Cookie: access_token=<jwt>. See Authentication.
GET /supply-chain/data-space/documents
GET /supply-chain/data-space/documents
Cookie: access_token=<jwt>List Documents
Returns documents shared with your organisation across all consignments.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Cursor returned by the previous response — omit to start from the beginning |
limit | number | No | Number of results per page |
consignmentId | string | No | Scope results to a specific consignment |
Response 200
Returns an array of DocumentAttachment objects — same shape as List Consignment Documents.
Errors
| Status | Cause |
|---|---|
401 | Missing or invalid credentials |
GET /supply-chain/data-space/consignments/:id/documents/:documentId
GET /supply-chain/data-space/consignments/:id/documents/:documentId
Cookie: access_token=<jwt>Get a Document
Returns a single document attached to a consignment. See Get a Consignment Document for the full response shape and error codes.