Get downloads for an order

GET/orders/{id}/downloads

Costs 1 rate-limit point · Rate limits

What the buyer of an order can download right now: one row per file with its download url (null while a watermark is still being applied, or when access is revoked, expired or the download limit is reached), the watermark state and the download count. A watermarked file's url is a signed link that stops working at url_expires_at; a plain file's url is a redirect that does not expire and a link is its own address, so both have url_expires_at null.

Also searched asdownload links for an orderresend download linkorder filescan the customer download

Path parameters

idstringRequired

Returns

dataarray of objects
Show 6 child attributesHide child attributes
- file_idstring, nullable
  Example: 66e2751c-9812-422c-864d-f8ce6a95c605
- assetobject
  Show 6 child attributesHide child attributes
  - idstring, nullable
    Example: 96fbe30b-c819-4cb8-9666-814c0c8853f1
  - namestring, nullable
    Example: Beginner's Guide.pdf
  - typestring, nullable
    Example: file
  - filenamestring, nullable
    Example: Beginner's Guide.pdf
  - content_typestring, nullable
    Example: application/pdf
  - byte_sizeinteger, nullable
    Example: 116711
- urlstring, nullable
  Example: https://files.filemonk.io/orders/5600000000001/guide.pdf?…
- url_expires_atstring, nullable
  Example: 2026-10-31T00:48:11Z
- watermarkobject
  Show 2 child attributesHide child attributes
  - enabledboolean, nullable
    Example: true
  - statusstring, nullable
    Example: ready
- download_countinteger, nullable
  Example: 0

Errors

401

Missing or invalid API key.

404

The resource does not exist for this shop, or the action path is not registered.

422

The request failed validation, or sent a key the action does not take (code: "unknown_parameters" with unknown and accepted). Nothing was saved.

429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix time the window ends); a 429 adds Retry-After (seconds), retry_after, retryable: true and a next_step in the body. A 429 did nothing: wait retry_after seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with per_page over many single reads.

Every error has the same shape: see Errors.

GET/orders/{id}/downloads

curl "https://app.filemonk.io/api/v2/external/orders/3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f/downloads" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/orders/3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f/downloads", {
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.filemonk.io/api/v2/external/orders/3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f/downloads",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v2/external/orders/3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f/downloads")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "data": [
    {
      "file_id": "66e2751c-9812-422c-864d-f8ce6a95c605",
      "asset": {
        "id": "96fbe30b-c819-4cb8-9666-814c0c8853f1",
        "name": "Beginner's Guide.pdf",
        "type": "file",
        "filename": "Beginner's Guide.pdf",
        "content_type": "application/pdf",
        "byte_size": 116711
      },
      "url": "https://files.filemonk.io/orders/5600000000001/guide.pdf?X-Amz-Expires=3600&X-Amz-Signature=3f6c…",
      "url_expires_at": "2026-10-31T00:48:11Z",
      "watermark": {
        "enabled": true,
        "status": "ready"
      },
      "download_count": 0
    }
  ]
}

{
  "errors": [
    "Invalid API key"
  ]
}

{
  "errors": [
    "Order not found: c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
  ]
}

{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}

{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}