Retrieve customer
/customers/{id}Costs 1 rate-limit point · Rate limits
One customer with every address on file and the documents issued to them: how many, and the most recent five with their numbers and sent/paid times. Accepts the Invoice Falcon customer id (a number) or the Shopify customer gid (gid://shopify/Customer/123). Read-only.
Also searched asshow customercustomer detailscustomer addressesinvoices for a customerhow many invoices did this customer get
Path parameters
idstringRequiredInvoice Falcon customer id (a number), or the Shopify customer gid gid://shopify/Customer/123.
Returns
The customer object.
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 resource does not exist for this shop, or no action is registered at this path.
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/customers/32" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/customers/32", {
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/customers/32",
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/customers/32")
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){
"id": 32,
"shopify_customer_id": "gid://shopify/Customer/9001",
"name": "Zoe Quinn",
"first_name": "Zoe",
"last_name": "Quinn",
"email": "zoe@example.com",
"phone": null,
"tax_number": "DE123",
"eori_number": null,
"tags": [
"vip",
"wholesale"
],
"edited_in_app": false,
"default_address": {
"id": 587,
"kind": "default_address",
"name": null,
"first_name": null,
"last_name": null,
"company": "Quinn GmbH",
"address1": "1 Main St",
"address2": null,
"city": "Berlin",
"province": null,
"zip": "10115",
"country": "Germany",
"country_code": "DE",
"phone": null,
"tax_number": null,
"eori_number": null
},
"created_at": "2026-11-10T08:50:31Z",
"updated_at": "2026-11-10T08:50:31Z",
"note": null,
"addresses": [
{
"id": 587,
"kind": "default_address",
"name": null,
"first_name": null,
"last_name": null,
"company": "Quinn GmbH",
"address1": "1 Main St",
"address2": null,
"city": "Berlin",
"province": null,
"zip": "10115",
"country": "Germany",
"country_code": "DE",
"phone": null,
"tax_number": null,
"eori_number": null
}
],
"documents": {
"count": 1,
"recent": [
{
"id": 980191020,
"type": "invoice",
"number": "INV-9",
"shopify_order_id": "gid://shopify/Order/1",
"created_at": "2026-11-10T08:50:31Z",
"sent_at": "2026-01-02T00:00:00Z",
"paid_at": null
}
]
}
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}