API reference
Read a customer
Fetch a shop's identity, tags, and custom fields.
GET/v1/customer
The read half of identify: returns the shop's identity, tags, and every set custom field visible to your app, including workspace-scope fields your team sets in the console and database-linked fields computed from a connected Postgres. Use it to carry console-side data back into your app.
Only fields with a value appear; defined-but-unset fields are omitted unless they carry a default value, which then stands in. Fields marked private in the console never appear here. customFieldTypes maps each returned field to its declared type.
Query parameters
myshopifyDomainstringrequired- The shop to read (
customerIdis accepted as an alias).
Returns
200The customer object.
400
myshopifyDomain missing.401Bad or missing
X-Api-Key.404No install of your app for that shop.