Get texts

GET/settings/texts

Costs 1 rate-limit point · Rate limits

Read the customer-facing texts in one locale, as the settings Translate view shows them: the download email, download page, download limit messages, order status and customer account blocks, and the EU withdrawal consent. locale defaults to the shop's default language. Values are what is stored for that locale only; untranslated lists the texts not translated yet (buyers see the default language there).

Paths match GET /settings. Write them with PATCH /settings/texts; fill a whole locale with Filemonk's own translation using POST /settings/texts/setup.

Also searched astranslationsread translated textswhat does the download page say in frenchwhich texts are not translatedemail text in german

Query parameters

localestring

Returns

localestring, nullable
Example: fr
default_localestring, nullable
Example: en
multi_language_enabledboolean, nullable
Example: true
shop_localesarray of strings
setup_localesarray of strings
textsobject
Show 2 child attributesHide child attributes
- emailobject
  Show 2 child attributesHide child attributes
  - subjectstring, nullable
    Example: Vos téléchargements sont prêts
  - buttonobject
    Show 1 child attributeHide child attributes
    textstring, nullable
    Example: Télécharger
- download_pageobject
  Show 1 child attributeHide child attributes
  - textsobject
    Show 2 child attributesHide child attributes
    thanksstring, nullable
    Example: Merci pour votre commande
    buttonany
untranslatedarray of strings

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/settings/texts

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

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

curl "https://app.filemonk.io/api/v2/external/settings/texts?locale=fr" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

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

{
  "locale": "fr",
  "default_locale": "en",
  "multi_language_enabled": true,
  "shop_locales": [
    "en",
    "fr"
  ],
  "setup_locales": [
    "pt-BR",
    "zh",
    "da",
    "nl",
    "en",
    "pt-PT",
    "fr",
    "de",
    "it",
    "ja",
    "ko",
    "nb",
    "es",
    "sv",
    "tr",
    "zh-TW",
    "pl"
  ],
  "texts": {
    "email": {
      "subject": "Vos téléchargements sont prêts",
      "button": {
        "text": "Télécharger"
      }
    },
    "download_page": {
      "texts": {
        "thanks": "Merci pour votre commande",
        "button": null
      }
    }
  },
  "untranslated": [
    "download_page.texts.button"
  ]
}

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