Skip to main content

Get Metafield by ID

This endpoint is available on the Admin API (merchant JWT) only. It is not exposed to OAuth-scoped apps. Apps must use GET /api/v1/metafields.json with namespace + key (or ownerType + ownerId) filters instead.
Returns a single metafield by its UUID. Used by the merchant admin and by the admin’s resource detail editors.

Request

Auth

Merchant JWT (owner, or staff with admin/manager access). The metafield must belong to the merchant’s store.

Path parameters

id
string
required
The metafield UUID.

Response

How apps should look up a single metafield

Use the list endpoint with exact filters — values are keyed by (owner type, namespace, key, owner), so there is at most one match:
Returns at most one item under data.metafields[0].

Error codes

CodeDescription
UNAUTHORIZEDInvalid or missing JWT
FORBIDDENWrong store / insufficient role
NOT_FOUNDMetafield does not exist or belongs to another store