Skip to main content
GET
/
metafield-definitions
List Metafield Definitions
curl --request GET \
  --url https://api.launchmystore.io/metafield-definitions \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

Use this file to discover all available pages before exploring further.

List Metafield Definitions

Admin API only — requires a merchant JWT. Not exposed to OAuth apps.
Returns paginated metafield definitions for the merchant’s store.

Request

curl -G "https://api.launchmystore.io/metafield-definitions" \
  -H "Authorization: Bearer <merchant-jwt>" \
  --data-urlencode "ownerType=product" \
  --data-urlencode "pinned=true"

Auth

Merchant JWT (MERCHANT, STAFF_ADMIN, SUPER_ADMIN, MANAGER).

Query parameters

ownerType
string
Filter by owner type (shop, product, variant, collection, customer, order, page, blog, article).
namespace
string
Filter by namespace.
key
string
Filter by exact key.
pinned
boolean
Filter to only pinned (or only unpinned) definitions.
page
integer
default:"1"
1-indexed page number.
limit
integer
default:"50"
Items per page.

Response

{
  "status": 200,
  "state": "success",
  "data": {
    "definitions": [
      {
        "id": "f7e3a920-...",
        "namespace": "custom",
        "key": "warranty_years",
        "name": "Warranty (years)",
        "description": "How many years of warranty are included",
        "type": "number_integer",
        "owner_type": "product",
        "validations": { "min": 0, "max": 25 },
        "pinned": true,
        "app_id": null,
        "created_at": "2026-05-09T13:30:00.000Z",
        "updated_at": "2026-05-09T13:30:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 50
  }
}

Error codes

CodeDescription
UNAUTHORIZEDInvalid or missing JWT
FORBIDDENWrong store / insufficient role