---
updatedAt: 2026-09-09T09:34:23.000Z
agentTools:
  siteIndex: https://documentation.bloomreach.com/llms.txt
  projectIndex: https://documentation.bloomreach.com/content/llms.txt
---

# Get meta-data for a field group

Get the meta-data for a specific field group only.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Site Management API",
    "description": "The Site Management API enables developers to manage channel configurations through a set of endpoints for operations on channels, layouts, component groups, routes, and menus.",
    "version": "1.0.0"
  },
  "externalDocs": {
    "description": "See official Bloomreach documentation",
    "url": "https://documentation.bloomreach.com/content/reference/site-management-api"
  },
  "servers": [
    {
      "url": "https://developers.bloomreach.io/management/site/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Channel Operations",
      "externalDocs": {
        "description": "See",
        "url": "https://documentation.bloomreach.com/developers/concepts/channels-and-pages-concepts.html#scroll_channel"
      }
    }
  ],
  "paths": {
    "/channels/{channel_id}/fieldgroups/{fieldgroup_name}": {
      "get": {
        "tags": [
          "Channel Operations"
        ],
        "summary": "Get meta-data for a field group",
        "operationId": "getFieldGroup",
        "parameters": [
          {
            "name": "channel_id",
            "in": "path",
            "description": "Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            },
            "example": "brxsaas-vIUy9"
          },
          {
            "name": "fieldgroup_name",
            "in": "path",
            "description": "Name of the fieldgroup",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            },
            "example": "group-key"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Resource-Version": {
                "description": "Resource's version. Must be used in any subsequent update requests of this resource",
                "style": "simple",
                "explode": false,
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FieldGroup"
                },
                "example": {
                  "name": "group-key",
                  "displayName": "Group key",
                  "parameters": [
                    "smAccountId"
                  ]
                }
              }
            }
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FieldGroup": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Field Group Name"
          },
          "displayName": {
            "type": "string",
            "description": "Field Group Display Name"
          },
          "parameters": {
            "type": "array",
            "description": "Field Group Parameters",
            "items": {
              "type": "string",
              "description": "Field Group Parameters"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "apiKey",
        "name": "x-auth-token",
        "in": "header"
      }
    }
  }
}
```