metaobjectDefinitions

Returns a paginated list of all MetaobjectDefinition objects configured for the store. Metaobject definitions provide the schema for creating custom data structures composed of individual fields.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the metaobjectDefinitions action (under Metaobject).
Fill in the fields below, then reference the result from later steps as {{metaobjectdefinitions.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query MetaobjectDefinitions($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  metaobjectDefinitions(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        access
        capabilities
        createdAt
        createdByApp
        createdByStaff
        description
        displayNameKey
        fieldDefinitions
        hasThumbnailField
        id
        metaobjectsCount
        name
        standardTemplate
        type
        updatedAt
      }
    }
    nodes {
      access {
        admin
        customerAccount
        storefront
      }
      capabilities {
        onlineStore
        publishable
        renderable
        translatable
      }
      createdAt
      createdByApp {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      createdByStaff {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
      description
      displayNameKey
      fieldDefinitions {
        capabilities
        description
        key
        name
        required
        type
        validations
      }
      hasThumbnailField
      id
      metaobjectsCount
      name
      standardTemplate {
        access
        description
        displayNameKey
        enabledCapabilities
        fieldDefinitions
        name
        type
      }
      type
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

Read the result with {{metaobjectdefinitions.response.data.data.metaobjectDefinitions}}. If the API returns errors, the step fails and they are at {{metaobjectdefinitions.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

accessobject

capabilitiesobject

createdAtobject

createdByAppobject

createdByStaffobject

descriptionobject

displayNameKeyobject

fieldDefinitionsobject

hasThumbnailFieldobject

idobject

metaobjectsCountobject

nameobject

standardTemplateobject

typeobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?