get_field_metadata
==================


.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    Access Pyxis Central Schema field metadata.








Arguments
---------




``type_name`` | String  :bdg-danger:`required` 






.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    The name of the Type to get metadata for.








``field_name`` | String  :bdg-danger:`required` 






.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    The name of the Type field to get metadata for. For nested fields, use dot notation.









Returns
-------

``response_type`` | single




``response_object`` | :doc:`/objects/FieldMetadata`



Query example

.. code-block:: graphql


    {
      get_field_metadata(type_name: "example", field_name: "example") {
        error {
          detail
          status
        }
        
        data {
          _id
        }
      }
    }