Retrieve integration settings
/account/integrationsCosts 1 rate-limit point · Rate limits
What the store has connected: whether an API key exists (never the key itself), the payment processor used for pay-now links and its mode, and the per-language texts of the Customer Accounts invoice download widget. Read-only.
Also searched asintegrationsis stripe connecteddo I have an API keycustomer accounts translationspayment processor settingsconnected apps
Returns
api_keyobjectShow 2 child attributesHide child attributes
configuredbooleanExample:truekeystring
payment_processorobjectShow 3 child attributesHide child attributes
connectedbooleanExample:falsenamestring, nullablestripe_checkout_v2booleanExample:false
customer_accountsobjectShow 1 child attributeHide child attributes
translationsarray of anys
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/account/integrations" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/account/integrations", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/account/integrations",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/account/integrations")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"api_key": {
"configured": true
},
"payment_processor": {
"connected": false,
"name": null,
"stripe_checkout_v2": false
},
"customer_accounts": {
"translations": []
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}