---
agentTools:
  projectIndex: https://imx.readme.io/llms.txt
---

# Get collection metadata schema

Get collection metadata schema

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Immutable X API",
    "version": "1.0",
    "description": "https://docs.x.immutable.com/reference",
    "contact": {
      "name": "Immutable",
      "url": "https://godsunchained.com"
    }
  },
  "servers": [
    {
      "url": "https://api.x.immutable.com",
      "description": "Production Environment"
    },
    {
      "url": "https://api.ropsten.x.immutable.com",
      "description": "Ropsten Environment"
    }
  ],
  "paths": {
    "/v1/collections/{address}/metadata-schema": {
      "parameters": [
        {
          "schema": {
            "type": "string"
          },
          "name": "address",
          "in": "path",
          "required": true,
          "description": "Collection contract address"
        }
      ],
      "get": {
        "summary": "Get collection metadata schema",
        "tags": [
          "collections"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CollectionMetadataSchema"
                  }
                }
              }
            }
          }
        },
        "operationId": "getCollectionMetadataSchema",
        "description": "Get collection metadata schema"
      }
    }
  },
  "components": {
    "schemas": {
      "CollectionMetadataSchema": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "name": "collectable",
            "type": "bool",
            "filterable": true
          }
        },
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Name of the metadata key"
          },
          "type": {
            "type": "string",
            "minLength": 1,
            "description": "Type of the metadata. Values: \"enum\", \"text\", \"boolean\", \"continuous\", \"discrete\" | Default: \"text\".\nSrc: https://docs.x.immutable.com/docs/asset-metadata#property-type-mapping"
          },
          "filterable": {
            "type": "boolean",
            "description": "Sets the metadata as filterable"
          }
        },
        "required": [
          "name",
          "type",
          "filterable"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "collections"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 222,
      "2": 73,
      "3": 4,
      "4": 47,
      "5": 148,
      "6": 195,
      "7": 0,
      "8": 100,
      "9": 250,
      "10": 119,
      "11": 107
    }
  }
}
```