---
title: privateMetafield - GraphQL Admin
description: Returns a `PrivateMetafield` resource by ID.
api_version: 2024-10
api_name: admin
type: query
api_type: graphql
source_url:
  html: 'https://shopify.dev/docs/api/admin-graphql/2024-10/queries/privateMetafield'
  md: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/queries/privateMetafield.txt
---

# private​Metafield

query

Deprecated.

Metafields created using a reserved namespace are private by default. See our guide for [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). This will be removed in 2025-01.

Returns a `PrivateMetafield` resource by ID.

## Arguments

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  required

  The ID of the `PrivateMetafield` to return.

***

## Possible returns

* Private​Metafield

  [Private​Metafield](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/PrivateMetafield)

  Private metafields represent custom metadata that is attached to a resource. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.

  An application can create a maximum of 10 private metafields per shop resource.

  Private metafields are deprecated. Metafields created using a reserved namespace are private by default. See our guide for [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).

***

## Examples

* ### Retrieve a private metafield by its ID

  #### Description

  To retrieve a single private metafield, use the \`privateMetafield\` query. The following example shows how to retrieve the private metafield owned by an \`Order\` resource.

  #### Query

  ```graphql
  query {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      id
      key
      namespace
      value
    }
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "query { privateMetafield(id: \"gid://shopify/PrivateMetafield/1060470840\") { id key namespace value } }"
  }'
  ```

  #### Remix

  ```javascript
  const { admin } = await authenticate.admin(request);

  const response = await admin.graphql(
    `#graphql
    query {
      privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
        id
        key
        namespace
        value
      }
    }`,
  );

  const data = await response.json();
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    query {
      privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
        id
        key
        namespace
        value
      }
    }
  QUERY

  response = client.query(query: query)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: `query {
      privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
        id
        key
        namespace
        value
      }
    }`,
  });
  ```

  #### Response

  ```json
  {
    "privateMetafield": {
      "id": "gid://shopify/PrivateMetafield/1060470840",
      "key": "buyer",
      "namespace": "notes",
      "value": "Notes about this buyer"
    }
  }
  ```

## Retrieve a private metafield by its ID

[Open in GraphiQL](http://localhost:3457/graphiql?query=query%20%7B%0A%20%20privateMetafield\(id%3A%20%22gid%3A%2F%2Fshopify%2FPrivateMetafield%2F1060470840%22\)%20%7B%0A%20%20%20%20id%0A%20%20%20%20key%0A%20%20%20%20namespace%0A%20%20%20%20value%0A%20%20%7D%0A%7D)

```javascript
const { admin } = await authenticate.admin(request);


const response = await admin.graphql(
  `#graphql
  query {
    privateMetafield(id: "gid://shopify/PrivateMetafield/1060470840") {
      id
      key
      namespace
      value
    }
  }`,
);


const data = await response.json();
```

## Response

JSON

```json
{
  "privateMetafield": {
    "id": "gid://shopify/PrivateMetafield/1060470840",
    "key": "buyer",
    "namespace": "notes",
    "value": "Notes about this buyer"
  }
}
```