Skip to content

Coming from v1

How every Filemonk API v1 endpoint maps to API v2, what changes in the request, and how to move at your own pace.

Last updated

v1 keeps working with the same key and the same rate-limit budget. You do not have to move. If you want the extra actions in v2 (licence keys, emails, settings, troubleshooting), or you are starting a new integration, this is where each v1 endpoint lands.

Base URLs: v1 is https://app.filemonk.io/api/v1/external, v2 is https://app.filemonk.io/api/v2/external.

API v1 API v2 Notes
GET /orders GET /orders Same filters (search, email, financial_status, product and date filters).
GET /orders/:id GET /orders/:id
GET /orders/:id/downloads GET /orders/:id/downloads Signed URLs and watermark status, as in v1.
POST /orders/:id/attach_assets POST /orders/:id/files/attach Body asset_ids.
DELETE /orders/:id/detach_assets POST /orders/:id/files/detach A named action instead of a DELETE with a body.
POST /orders/:id/notify POST /orders/:id/send_email Sends the download email for the order.
GET /assets GET /assets
GET /assets/:id GET /assets/:id
POST /assets POST /assets A stored file answers with an upload object (url, method, headers, expires_at): PUT the file body there within the hour. Nothing else is needed.
PATCH /assets/:id PATCH /assets/:id
DELETE /assets/:id DELETE /assets/:id Previews first.
POST /assets/:id/replace POST /assets/:id/replace
GET /digital_products GET /digital_products
GET /digital_products/:id GET /digital_products/:id
POST /digital_products POST /digital_products
PATCH /digital_products/:id PATCH /digital_products/:id
DELETE /digital_products/:id DELETE /digital_products/:id Previews first.
POST /digital_products/:id/notify_buyers POST /digital_products/:id/notify_buyers
  • Authentication is the same. Same key, same X-Auth-Token header.
  • Lists are wrapped. v2 lists answer {"data": [...], "meta": {...}}. See Pagination and sorting.
  • Errors have one shape. {"errors": [...]} with optional machine-readable keys. See Errors and rate limits.
  • Deletes ask first. Destructive actions answer 409 until you send confirm. See Previews and confirm.
  • Shopify ids are gids. v2 returns Shopify ids as gid://shopify/Product/123, and accepts the gid or the plain number.
  • Unknown fields are rejected with a 422 that lists what the action takes, instead of being ignored.
Was this page helpful?

Still stuck? Ask Quinn or chat with support