# metafieldDefinitions - admin-graphql - QUERY Version: 2025-01 ## Description Returns a list of metafield definitions. ### Access Scopes ## Arguments * [after](/docs/api/admin-graphql/2025-01/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [before](/docs/api/admin-graphql/2025-01/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [constraintStatus](/docs/api/admin-graphql/2025-01/enums/MetafieldDefinitionConstraintStatus): MetafieldDefinitionConstraintStatus - Filter metafield definitions based on whether they are constrained. * [constraintSubtype](/docs/api/admin-graphql/2025-01/input-objects/MetafieldDefinitionConstraintSubtypeIdentifier): MetafieldDefinitionConstraintSubtypeIdentifier - Filter metafield definitions based on whether they apply to a given resource subtype. * [first](/docs/api/admin-graphql/2025-01/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [key](/docs/api/admin-graphql/2025-01/scalars/String): String - Filter metafield definition by key. * [last](/docs/api/admin-graphql/2025-01/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [namespace](/docs/api/admin-graphql/2025-01/scalars/String): String - Filter metafield definition by namespace. * [ownerType](/docs/api/admin-graphql/2025-01/enums/MetafieldOwnerType): MetafieldOwnerType! - Filter the metafield definition by the specific owner type. * [pinnedStatus](/docs/api/admin-graphql/2025-01/enums/MetafieldDefinitionPinnedStatus): MetafieldDefinitionPinnedStatus - Filter the metafield definition by the pinned status. * [query](/docs/api/admin-graphql/2025-01/scalars/String): String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | created_at | time | Filter by the date and time when the metafield definition was created. | | | - `created_at:>2020-10-21T23:39:20Z`<br/> - `created_at:<now`<br/> - `created_at:<=2024` | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | key | string | Filter by the metafield definition [`key`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-key) field. | | | - `key:some-key` | | namespace | string | Filter by the metafield definition [`namespace`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-namespace) field. | | | - `namespace:some-namespace` | | owner_type | string | Filter by the metafield definition [`ownerType`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-ownertype) field. | | | - `owner_type:PRODUCT` | | type | string | Filter by the metafield definition [`type`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-type) field. | | | - `type:single_line_text_field` | | updated_at | time | Filter by the date and time when the metafield definition was last updated. | | | - `updated_at:>2020-10-21T23:39:20Z`<br/> - `updated_at:<now`<br/> - `updated_at:<=2024` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * [reverse](/docs/api/admin-graphql/2025-01/scalars/Boolean): Boolean - Reverse the order of the underlying list. * [sortKey](/docs/api/admin-graphql/2025-01/enums/MetafieldDefinitionSortKeys): MetafieldDefinitionSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). ## Returns * [edges](/docs/api/admin-graphql/2025-01/objects/MetafieldDefinitionEdge): MetafieldDefinitionEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. * [nodes](/docs/api/admin-graphql/2025-01/objects/MetafieldDefinition): MetafieldDefinition! A list of nodes that are contained in MetafieldDefinitionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. * [pageInfo](/docs/api/admin-graphql/2025-01/objects/PageInfo): PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. ## Examples ### Retrieve metafield definitions Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { metafieldDefinitions(first: 250, ownerType: PRODUCT) { edges { node { name } } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query {\n metafieldDefinitions(first: 250, ownerType: PRODUCT) {\n edges {\n node {\n name\n }\n }\n }\n }`,\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query {\n metafieldDefinitions(first: 250, ownerType: PRODUCT) {\n edges {\n node {\n name\n }\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query {\n metafieldDefinitions(first: 250, ownerType: PRODUCT) {\n edges {\n node {\n name\n }\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query {\n metafieldDefinitions(first: 250, ownerType: PRODUCT) {\n edges {\n node {\n name\n }\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "metafieldDefinitions": { "edges": [ { "node": { "name": "legacy definition" } }, { "node": { "name": "Non-standard rating" } }, { "node": { "name": "date of creation" } }, { "node": { "name": "Custom ID" } }, { "node": { "name": "create" } }, { "node": { "name": "amenity" } }, { "node": { "name": "youbube video" } }, { "node": { "name": "Swatch List" } }, { "node": { "name": "Spiceness metaobject reference" } }, { "node": { "name": "model" } }, { "node": { "name": "Competitor cost" } }, { "node": { "name": "Season" } }, { "node": { "name": "Year released" } }, { "node": { "name": "youtubee video" } }, { "node": { "name": "date of creation" } }, { "node": { "name": "youtube video" } }, { "node": { "name": "Spiceness metaobject reference" } }, { "node": { "name": "nutrition field" } }, { "node": { "name": "Materials" } }, { "node": { "name": "Taxonomy materials" } }, { "node": { "name": "Recyclable" } }, { "node": { "name": "Looksbooks List" } }, { "node": { "name": "geographical availability" } }, { "node": { "name": "Color List" } }, { "node": { "name": "Exporters" } }, { "node": { "name": "Looksbooks List" } }, { "node": { "name": "youtubbe video" } }, { "node": { "name": "Ingredients" } } ] } } }