List Files

GEThttps://api.cargopanel.co/v1/files

GEThttps://sandbox-api.cargopanel.co/v1/files

Retrieves all files matching a specific database file identifier.

Request Fields

idrequiredstring

The 6-digit database identifier of the file.

Example Response

200

{
  "files": [
    {
      "originalName": "invoice.pdf",
      "fileName": "invoice_usr_xyz789_539103",
      "url": "https://api.cargopanel.co/v1/files/invoice_usr_xyz789_539103",
      "path": "/files/invoice_usr_xyz789_539103",
      "id": "539103",
      "userId": "usr_xyz789",
      "shipmentId": "shp_abc123",
      "documentType": "invoice"
    }
  ],
  "id": "539103"
}

Response Fields

filesarray

An array containing matching file's metadata objects.

idstring

The queried file ID parameter.

Responses

200Files retrieved successfully

400Bad Request (missing query parameter id)

401Unauthorized (invalid or missing API key)

Upload File

Get File by Filename