> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch custom field metadata

> Return list of custom field functions, rules of lookups and conditions, and list of field data types that can be used for custom fields

## OpenAPI

````json GET /v1/teams/{team_id}/custom-fields/metadata
{
  "openapi": "3.0.3",
  "info": {
    "title": "Management API Reference",
    "version": "2.0.0",
    "description": "API Documentation for the Supermetrics Management API. For more information, visit https://supermetrics.com.",
    "termsOfService": "https://supermetrics.com/terms-of-service",
    "contact": {
      "name": "Supermetrics Suppot",
      "email": "support@supermetrics.com",
      "url": "https://supermetrics.com/support"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "x-api-id": "sm-management-api",
    "x-audience": "public"
  },
  "servers": [
    {
      "url": "https://api.supermetrics.com/v2",
      "description": "Global production public Supermetrics Management API base path.",
      "x-internal": false
    },
    {
      "url": "https://api.supermetrics.com",
      "description": "Global production public Supermetrics API base path (for Connector Builder and Team endpoints).",
      "x-internal": false
    }
  ],
  "tags": [
    {
      "name": "API Keys",
      "description": "Manage API keys to access Supermetrics API"
    },
    {
      "name": "Saved Queries",
      "description": "Manage queries saved in Query Manager"
    },
    {
      "name": "Datasources",
      "description": "Retrieve datasource configuration details"
    },
    {
      "name": "Data Source Logins",
      "description": "Access your data source authentications and login links"
    },
    {
      "name": "Custom Fields",
      "description": "Create and manage Custom Fields"
    },
    {
      "name": "Account Tags",
      "description": "Group data source accounts into reusable tags"
    },
    {
      "name": "Data Blending",
      "description": "Create and manage Data Blending"
    },
    {
      "name": "Connector Builder",
      "description": "Create and manage custom connectors, including their secrets, logos, logs, and schemas"
    },
    {
      "name": "Teams",
      "description": "View and update team details"
    },
    {
      "name": "Team Users",
      "description": "Manage members and invitations for your team"
    },
    {
      "name": "Team Licenses",
      "description": "Assign and manage your team's licenses"
    },
    {
      "name": "Team Settings",
      "description": "Configure general settings for your team"
    },
    {
      "name": "Workspaces",
      "description": "Create and manage workspaces, their members, and license pools"
    },
    {
      "name": "Data Transfers",
      "description": "Create, configure, and manage Data Warehouse transfers, their runs, backfills, and data source connections"
    },
    {
      "name": "Data Destinations",
      "description": "Create, configure, and manage Data Warehouse destinations"
    },
    {
      "name": "Table Groups",
      "description": "Manage your team's table groups"
    }
  ],
  "externalDocs": {
    "description": "Find out more about Supermetrics Management API",
    "url": "https://docs.supermetrics.com/apidocs/management-api"
  },
  "paths": {
    "/v1/teams/{team_id}/custom-fields/metadata": {
      "servers": [
        {
          "url": "https://api.supermetrics.com",
          "description": "production server",
          "x-internal": false
        }
      ],
      "get": {
        "summary": "Fetch custom field metadata",
        "description": "Return list of custom field functions, rules of lookups and conditions, and list of field data types that can be used for custom fields",
        "operationId": "fetchMetadata",
        "parameters": [
          {
            "$ref": "#/components/parameters/TeamId"
          },
          {
            "name": "Sm-App-Id",
            "in": "header",
            "required": false,
            "description": "Application identifier",
            "schema": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^[A-Za-z0-9_-]+$"
            },
            "example": "XPLD"
          }
        ],
        "responses": {
          "200": {
            "description": "Metadata fetched successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MetadataOutput"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/PermissionDenied"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "ApiKeyAuth": [
              "custom_fields_read"
            ]
          }
        ],
        "tags": [
          "Custom Fields"
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "TeamId": {
        "name": "team_id",
        "in": "path",
        "description": "ID of the team",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1,
          "maximum": 9.223372036854776E+18
        },
        "example": 936506
      }
    },
    "schemas": {
      "MetadataOutput": {
        "description": "Success envelope describing the metadata available for building custom fields: the functions, condition/lookup rules, field data types, output data types, and the team's transformation-step limit.",
        "allOf": [
          {
            "$ref": "#/components/schemas/AbstractResponse"
          },
          {
            "type": "object",
            "required": [
              "data"
            ],
            "properties": {
              "data": {
                "type": "object",
                "description": "Metadata for custom field transformations.",
                "properties": {
                  "rules": {
                    "type": "object",
                    "description": "Matching rules available for condition and lookup steps.",
                    "properties": {
                      "condition": {
                        "type": "object",
                        "description": "Rules available for condition steps.",
                        "properties": {
                          "items": {
                            "type": "array",
                            "maxItems": 1000,
                            "description": "Available condition rules.",
                            "items": {
                              "$ref": "#/components/schemas/RuleOutput"
                            }
                          }
                        }
                      },
                      "lookup": {
                        "type": "object",
                        "description": "Rules available for lookup steps.",
                        "properties": {
                          "items": {
                            "type": "array",
                            "maxItems": 1000,
                            "description": "Available lookup rules.",
                            "items": {
                              "$ref": "#/components/schemas/RuleOutput"
                            }
                          }
                        }
                      }
                    }
                  },
                  "functions": {
                    "type": "object",
                    "description": "Wrapper holding the available transformation functions.",
                    "properties": {
                      "items": {
                        "type": "array",
                        "maxItems": 1000,
                        "description": "Available transformation functions.",
                        "items": {
                          "$ref": "#/components/schemas/FunctionSpecificationOutput"
                        }
                      }
                    }
                  },
                  "field_data_types": {
                    "type": "array",
                    "maxItems": 1000,
                    "description": "Field data types that can be used for transformations.",
                    "example": [
                      "string.text.value"
                    ],
                    "items": {
                      "type": "string",
                      "maxLength": 100,
                      "pattern": "^.+$",
                      "description": "A single field data type identifier."
                    }
                  },
                  "output_data_types": {
                    "type": "object",
                    "description": "Wrapper holding the available output data types.",
                    "properties": {
                      "items": {
                        "type": "array",
                        "maxItems": 1000,
                        "description": "Output data types available for transformations.",
                        "items": {
                          "$ref": "#/components/schemas/OutputDataTypeOutput"
                        }
                      }
                    }
                  },
                  "data_transformation_steps_limit": {
                    "type": "integer",
                    "format": "int32",
                    "minimum": 1,
                    "maximum": 2147483647,
                    "example": 10,
                    "description": "Maximum number of transformation steps allowed for the team."
                  }
                }
              }
            }
          }
        ],
        "example": {
          "meta": {
            "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
          },
          "data": {
            "rules": {
              "condition": {
                "items": [
                  {
                    "name": "equals",
                    "display_name": "EQUALS"
                  }
                ]
              },
              "lookup": {
                "items": [
                  {
                    "name": "equals",
                    "display_name": "EQUALS"
                  }
                ]
              }
            },
            "functions": {
              "items": [
                {
                  "name": "upper_case",
                  "display_name": "Upper Case",
                  "description": "Converts text to upper case",
                  "group_name": "String",
                  "arguments": [
                    {
                      "name": "value"
                    }
                  ],
                  "return_types": [
                    "string.text.value"
                  ]
                }
              ]
            },
            "field_data_types": [
              "string.text.value"
            ],
            "output_data_types": {
              "items": [
                {
                  "output_type": "string.text.value",
                  "label": "STRING"
                }
              ]
            },
            "data_transformation_steps_limit": 10
          }
        }
      },
      "AbstractResponse": {
        "type": "object",
        "description": "Base envelope for all successful API responses. Concrete responses extend this via `allOf` and add a `data` property.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/Meta"
          }
        },
        "required": [
          "meta"
        ]
      },
      "RuleOutput": {
        "type": "object",
        "description": "A matching rule available for condition or lookup steps.",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^[A-Za-z0-9_-]+$",
            "example": "equals",
            "description": "Internal name of the rule."
          },
          "display_name": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^.+$",
            "example": "EQUALS",
            "description": "Human-readable name of the rule."
          }
        },
        "example": {
          "name": "equals",
          "display_name": "EQUALS"
        }
      },
      "FunctionSpecificationOutput": {
        "type": "object",
        "description": "Specification of a function available for building function steps.",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^[A-Za-z0-9_-]+$",
            "example": "upper_case",
            "description": "Internal name of the function."
          },
          "display_name": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^.+$",
            "example": "Upper Case",
            "description": "Human-readable name of the function."
          },
          "description": {
            "type": "string",
            "maxLength": 2048,
            "pattern": "^.+$",
            "example": "Converts text to upper case",
            "description": "Detailed description of what the function does."
          },
          "group_name": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^.+$",
            "example": "String",
            "description": "Group the function belongs to."
          },
          "arguments": {
            "type": "array",
            "maxItems": 100,
            "description": "Input arguments expected by the function.",
            "example": [
              {
                "name": "value"
              }
            ],
            "items": {
              "type": "object",
              "description": "A single function argument specification."
            }
          },
          "return_types": {
            "type": "array",
            "maxItems": 100,
            "description": "Data types the function can return.",
            "example": [
              "string.text.value"
            ],
            "items": {
              "type": "string",
              "maxLength": 100,
              "pattern": "^.+$",
              "description": "A single valid return data type."
            }
          }
        },
        "example": {
          "name": "upper_case",
          "display_name": "Upper Case",
          "description": "Converts text to upper case",
          "group_name": "String",
          "arguments": [
            {
              "name": "value"
            }
          ],
          "return_types": [
            "string.text.value"
          ]
        }
      },
      "OutputDataTypeOutput": {
        "type": "object",
        "description": "An output data type available for custom field transformations.",
        "properties": {
          "output_type": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^.+$",
            "example": "string.text.value",
            "description": "The output data type identifier."
          },
          "label": {
            "type": "string",
            "maxLength": 100,
            "pattern": "^.+$",
            "nullable": true,
            "example": "STRING",
            "description": "Human-readable label describing the output type."
          }
        },
        "example": {
          "output_type": "string.text.value",
          "label": "STRING"
        }
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard envelope returned by all error (4xx/5xx) responses.",
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/Meta"
          },
          "error": {
            "$ref": "#/components/schemas/Error"
          }
        },
        "required": [
          "meta",
          "error"
        ],
        "additionalProperties": false
      },
      "Meta": {
        "type": "object",
        "description": "Metadata included in every API response.",
        "properties": {
          "request_id": {
            "$ref": "#/components/schemas/RequestId"
          }
        },
        "required": [
          "request_id"
        ],
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "description": "Machine- and human-readable detail for a failed request.",
        "properties": {
          "code": {
            "type": "string",
            "pattern": "^[A-Z][A-Z0-9_]*$",
            "maxLength": 100,
            "description": "Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on `message`. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.",
            "example": "BAD_REQUEST"
          },
          "message": {
            "type": "string",
            "maxLength": 255,
            "pattern": "^.+$",
            "description": "Short, human-readable summary of the error.",
            "example": "The request was invalid."
          },
          "description": {
            "type": "string",
            "maxLength": 2048,
            "description": "Optional longer explanation specific to this occurrence.",
            "example": "The field 'display_name' must not be empty."
          }
        },
        "required": [
          "code",
          "message"
        ],
        "additionalProperties": false
      },
      "RequestId": {
        "type": "string",
        "description": "Unique identifier for the request, for tracking and debugging.",
        "pattern": "^[A-Za-z0-9_-]+$",
        "minLength": 8,
        "maxLength": 64,
        "example": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN",
        "x-faker": {
          "random.alphaNumeric": 30
        }
      }
    },
    "responses": {
      "BadRequest": {
        "description": "Bad request - invalid parameters",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "BAD_REQUEST",
                "message": "The request was invalid."
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "headers": {
          "WWW-Authenticate": {
            "$ref": "#/components/headers/WWW-Authenticate"
          },
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "UNAUTHORIZED",
                "message": "Authentication is required."
              }
            }
          }
        }
      },
      "PermissionDenied": {
        "description": "Permission denied",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "PERMISSION_ERROR",
                "message": "You do not have permission to perform this action."
              }
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "Too Many Requests",
        "headers": {
          "X-RateLimit-Limit": {
            "$ref": "#/components/headers/X-RateLimit-Limit"
          },
          "X-RateLimit-Remaining": {
            "$ref": "#/components/headers/X-RateLimit-Remaining"
          },
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "TOO_MANY_REQUESTS",
                "message": "Rate limit exceeded. Retry later."
              }
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "headers": {
          "Access-Control-Allow-Origin": {
            "$ref": "#/components/headers/Access-Control-Allow-Origin"
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "meta": {
                "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
              },
              "error": {
                "code": "INTERNAL_SERVER_ERROR",
                "message": "An unexpected error occurred."
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API_KEY",
        "description": "API key authentication. Create API keys in the Supermetrics Hub and send\nthem in the Authorization header:\n`Authorization: Bearer <your-api-key>`\n"
      }
    },
    "headers": {
      "X-RateLimit-Limit": {
        "description": "Request limit per hour",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 10000,
          "example": 5000
        }
      },
      "X-RateLimit-Remaining": {
        "description": "Remaining requests in current window",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "maximum": 10000,
          "example": 4999
        }
      },
      "Access-Control-Allow-Origin": {
        "description": "CORS header",
        "schema": {
          "type": "string",
          "maxLength": 255,
          "enum": [
            "*"
          ],
          "example": "*"
        }
      },
      "WWW-Authenticate": {
        "description": "Bearer token required",
        "schema": {
          "type": "string",
          "maxLength": 255,
          "pattern": "^Bearer.*"
        }
      },
      "Retry-After": {
        "description": "Seconds until rate limit resets",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 86400,
          "example": 3600
        }
      }
    }
  }
}
````