Skip to main content
GET
List Metafields

List Metafields

Returns metafields written by your app (scoped by appId). Filter by owner type, owner id, namespace, or key.
This endpoint returns only the metafields your app has written. To list all metafields on a resource (including those written by other apps or merchants), the merchant must use the Admin API (GET /metafields?ownerType=...&ownerId=...).

Request

Required scope

read_metafields

Query parameters

string
Filter by owner type. One of shop, product, variant, collection, customer, order, page, blog, article. Lowercase only. Both casings are accepted: owner_type and ownerType behave identically.
string
Filter by the owning resource id. Not enforced by the API, but strongly recommended for every owner type except shop — without it you get all rows of that owner type. Both casings are accepted: owner_id and ownerId behave identically.
string
Filter by namespace.
string
Filter by exact key.
integer
default:"1"
1-indexed page number.
integer
default:"50"
Items per page. The API applies no hard cap; keep requests to 250 or fewer as a practical limit.

Response

integer
HTTP status code (200 on success).
string
success or error.
array
Array of metafield objects.
integer
Total matching records.
integer
Current page.
integer
Page size.

Example response

Error codes