Get account

GET/account

Costs 1 rate-limit point · Rate limits

The shop this API key belongs to: its domain, name, contact email, currency and time zone, the Filemonk plan it is on with the plan's limits (orders per cycle, file count, storage and bandwidth, in bytes), and the current billing cycle's usage (bytes uploaded, bytes downloaded, paid orders). Read-only; nothing about charges or money.

Also searched asmy accountmy planwhich plan am I onusagehow much storage have I usedbandwidth usedorders this monthshop detailswhose key is this

Returns

idstring, nullable
Example: acdfd70d-145e-4151-b88a-ce77a4108b43
shopify_domainstring, nullable
Example: example-store.myshopify.com
namestring, nullable
Example: Example Store
emailstring, nullable
Example: shopper@example.com
currencystring, nullable
Example: INR
time_zonestring, nullable
Example: America/New_York
planobject
Show 6 child attributesHide child attributes
- namestring, nullable
  Example: pro_per_order
- typestring, nullable
  Example: pro
- order_limitinteger, nullable
  Example: 2500
- asset_count_limitinteger, nullable
  Example: 10000
- asset_storage_bytesinteger, nullable
  Example: 1000000000000
- bandwidth_bytesany
usageobject
Show 3 child attributesHide child attributes
- uploaded_bytesinteger, nullable
  Example: 217370
- bandwidth_used_bytesinteger, nullable
  Example: 800900
- orders_countinteger, nullable
  Example: 3
created_atstring, nullable
Example: 2025-03-04T13:34:39Z

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.

GET/account

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

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

{
  "id": "acdfd70d-145e-4151-b88a-ce77a4108b43",
  "shopify_domain": "example-store.myshopify.com",
  "name": "Example Store",
  "email": "shopper@example.com",
  "currency": "INR",
  "time_zone": "America/New_York",
  "plan": {
    "name": "pro_per_order",
    "type": "pro",
    "order_limit": 2500,
    "asset_count_limit": 10000,
    "asset_storage_bytes": 1000000000000,
    "bandwidth_bytes": null
  },
  "usage": {
    "uploaded_bytes": 217370,
    "bandwidth_used_bytes": 800900,
    "orders_count": 3
  },
  "created_at": "2025-03-04T13:34:39Z"
}

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