Skip to main content
GET
/
orders
curl -X GET 'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10' \
  -H 'X-Auth-Token: fm_api_key_your_key_here'

{
  "orders": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "#1042",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "total_price": "29.99",
      "currency": "USD",
      "created_at": "2026-03-01T14:30:00Z",
      "download_count": 3
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "#1041",
      "email": "buyer@example.com",
      "phone": null,
      "financial_status": "paid",
      "fulfillment_status": null,
      "total_price": "9.99",
      "currency": "USD",
      "created_at": "2026-02-28T09:15:00Z",
      "download_count": 1
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_count": 142,
    "total_pages": 15
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.filemonk.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Query parameters

​
q
string
Search by order name/number or customer email. Performs a partial, case-insensitive match.
​
email
string
Filter by customer email address. Partial, case-insensitive match.
​
status
string
Filter by financial status. Accepts: paid, pending, partially_paid, partially_refunded, refunded, voided, authorized.
​
created_at_min
string
Filter orders created on or after this date. Format: YYYY-MM-DD.
​
created_at_max
string
Filter orders created on or before this date. Format: YYYY-MM-DD.
​
page
integer
default:"1"
Page number for pagination.
​
per_page
integer
default:"25"
Number of orders per page. Minimum: 1, maximum: 250.
​
sort
string
default:"created_at_desc"
Sort order. Accepts: created_at_desc, created_at_asc, name_asc, name_desc.

​
Response

​
orders
array
required
List of order objects.
​
pagination
object
required
Pagination metadata.
curl -X GET 'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10' \
  -H 'X-Auth-Token: fm_api_key_your_key_here'

{
  "orders": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "#1042",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "total_price": "29.99",
      "currency": "USD",
      "created_at": "2026-03-01T14:30:00Z",
      "download_count": 3
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "#1041",
      "email": "buyer@example.com",
      "phone": null,
      "financial_status": "paid",
      "fulfillment_status": null,
      "total_price": "9.99",
      "currency": "USD",
      "created_at": "2026-02-28T09:15:00Z",
      "download_count": 1
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_count": 142,
    "total_pages": 15
  }
}