List orders

GET/orders

Costs 1 rate-limit point · Rate limits

List the orders Filemonk delivers files for, newest first by ordered_at (when the buyer placed the order; sort=created_at desc orders by when Filemonk recorded it), paginated (page, per_page up to 200). meta.total_count is the number of orders. search matches the order name, email or phone the way the Orders page search does. financial_status filters by Shopify financial status; access by Filemonk's access state (active, revoked, partially_revoked, expired); email, customer_id, shopify_product_id and digital_product_id narrow to one buyer or one product; created_at_min / created_at_max (or from / to) are ISO 8601 bounds on when Filemonk recorded the order. Deleted orders are left out.

Also searched aslist ordersrecent ordersorders for a customerwho bought this productunpaid ordersorders with access revokedsearch orders

Query parameters

financial_statusstring
One of pendingauthorizedpartially_paidpaidpartially_refundedrefundedvoided
accessstring
One of activerevokedpartially_revokedexpired
sortstring
One of ordered_at descordered_at asccreated_at desccreated_at ascname ascname descemail ascemail descnotified_at ascnotified_at desc
pageinteger
1-based page number.
Default 1
per_pageinteger
Rows per page, max 200.
Default 50
searchstring
emailstring
customer_idstring
shopify_product_idstring
digital_product_idstring
created_at_minstring
created_at_maxstring
fromstring
tostring

Returns

dataarray of objects
Show 11 child attributesHide child attributes
- idstring, nullable
  Example: 3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f
- shopify_order_idstring, nullable
  Example: gid://shopify/Order/7555375595815
- namestring, nullable
  Example: #1077
- ordered_atstring, nullable
  Example: 2026-10-26T14:19:15Z
- customerobject
  Show 3 child attributesHide child attributes
  - emailstring, nullable
    Example: shopper@example.com
  - first_namestring, nullable
    Example: Jane
  - last_namestring, nullable
    Example: Doe
- totalobject
  Show 2 child attributesHide child attributes
  - amountstring, nullable
    Example: 1142.89
  - currencystring, nullable
    Example: INR
- statusobject
  Show 2 child attributesHide child attributes
  - financialstring, nullable
    Example: paid
  - flagged_as_fraudboolean, nullable
    Example: false
- accessobject
  Show 2 child attributesHide child attributes
  - statestring, nullable
    Example: active
  - downloads_countinteger, nullable
    Example: 0
- deliveryobject
  Show 1 child attributeHide child attributes
  - email_sent_atstring, nullable
    Example: 2026-10-30T22:34:30Z
- line_items_countinteger, nullable
  Example: 2
- created_atstring, nullable
  Example: 2026-10-26T14:19:29Z
currencystring, nullable
Example: INR
metaobject
Paging of a list (page, per_page query params).
Show 4 child attributesHide child attributes
- total_countinteger
  Rows across all pages.
- pageinteger
  1-based page number.
- per_pageinteger
  Rows per page, max 200.
- total_pagesinteger
  Example: 1

Errors

401

Missing or invalid API key.

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.

Example

GET/orders

curl "https://app.filemonk.io/api/v2/external/orders" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/orders", {
  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",
    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")
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)

GET/orders

curl "https://app.filemonk.io/api/v2/external/orders?financial_status=pending&access=active&sort=ordered_at%20desc" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v2/external/orders?financial_status=pending&access=active&sort=ordered_at%20desc", {
  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?financial_status=pending&access=active&sort=ordered_at%20desc",
    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?financial_status=pending&access=active&sort=ordered_at%20desc")
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": [
    {
      "id": "3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
      "shopify_order_id": "gid://shopify/Order/7555375595815",
      "name": "#1077",
      "ordered_at": "2026-10-26T14:19:15Z",
      "customer": {
        "email": "shopper@example.com",
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "total": {
        "amount": "1142.89",
        "currency": "INR"
      },
      "status": {
        "financial": "paid",
        "flagged_as_fraud": false
      },
      "access": {
        "state": "active",
        "downloads_count": 0
      },
      "delivery": {
        "email_sent_at": "2026-10-30T22:34:30Z"
      },
      "line_items_count": 2,
      "created_at": "2026-10-26T14:19:29Z"
    }
  ],
  "currency": "INR",
  "meta": {
    "total_count": 48,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}

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

{
  "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)."
}