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

# Get settings schema

> Retrieve the configuration schema for settings.



## OpenAPI

````yaml /api-reference/5.9/fusion-api-templating.json get /settings/_schema
openapi: 3.0.1
info:
  title: Fusion Templating API
  description: >-
    This API lets you perform create, read, update, and delete (CRUD) operations
    on templates and zones, and retrieve and render templates for particular
    navigation states.
  termsOfService: https://lucidworks.com/legal/developer-license-agreement/
  contact:
    name: Lucidworks
    url: https://lucidworks.com
    email: support@lucidworks.com
  license:
    name: License of API
    url: https://lucidworks.com/legal/developer-license-agreement/
  version: '5.9'
servers:
  - url: https://{FUSION_HOST.com}/api/templating
    description: Fusion
    variables:
      FUSION_HOST.com:
        default: ''
security: []
tags:
  - name: page-metadata-controller
    description: Endpoints with this tag modify page metadata.
  - name: render-controller
    description: >-
      Endpoints with this tag use the GET and POST operations to retrieve,
      render, create, read, update, and delete Fusion application templates that
      are published or in staging (unpublished).
  - name: template-settings-controller
    description: >-
      Endpoints with this tag use the GET, POST, PUT, and DELETE operations to
      create, read, update, and delete configuration information for the Fusion
      Templating service.
  - name: templates-controller
    description: >-
      Endpoints with this tag use the GET, POST, PUT, and DELETE operations to
      create, read, update, and delete Fusion application template information.
  - name: trigger-controller
    description: >-
      Endpoints with this tag use the GET and POST operations to retrieve,
      create, read, and update the Fusion application templates that are
      published or in staging (unpublished) without rendering.
  - name: zones-controller
    description: >-
      Endpoints with this tag use the GET, POST, PUT, and DELETE operations to
      retrieve, create, read, update, and delete zone information (Fusion query
      profiles).
paths:
  /settings/_schema:
    get:
      tags:
        - template-settings-controller
      summary: Get settings schema
      description: Retrieve the configuration schema for settings.
      operationId: get-settings-schema
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/settingsSchemaResponse'
        '401':
          description: Unauthorized
          content: {}
        '403':
          description: Forbidden
          content: {}
        '404':
          description: Not Found
          content: {}
components:
  schemas:
    settingsSchemaResponse:
      title: Settings Schema Response
      x-stoplight:
        id: uejuwv5lhzdup
      type: object
      properties:
        type:
          type: string
          x-stoplight:
            id: pqfm30j96ua39
          default: object
          description: The type of object returned in the response.
        title:
          type: string
          x-stoplight:
            id: 01jz2w6qf8sq7
          description: Description of what is returned in the schema response.
          example: General settings of the template service.
        description:
          type: string
          x-stoplight:
            id: kymcvvdtcuzug
          example: Stores common application configuration of templating service.
          description: Description of the information stored in the schema.
        properties:
          type: object
          x-stoplight:
            id: fuqvg1yogwod4
          description: Properties stored in the schema.
          properties:
            id:
              type: object
              x-stoplight:
                id: 2n2m7oz05nt4y
              description: Identifier properties of the settings in the schema.
              properties:
                type:
                  type: string
                  x-stoplight:
                    id: frt0njz2mu6hk
                  description: The type of identifier.
                title:
                  type: string
                  x-stoplight:
                    id: l3163jwdrvz6d
                  description: The title of the identifier.
                description:
                  type: string
                  x-stoplight:
                    id: exlsvgv37a08y
                  description: The description of the identifier of this object.
            app:
              type: object
              x-stoplight:
                id: 1yiizvkyl2z47
              properties:
                type:
                  type: string
                  x-stoplight:
                    id: 6pnfw478tr607
                  description: The type of application in the schema.
                title:
                  type: string
                  x-stoplight:
                    id: 1o97rkux48cr4
                  description: The Fusion application name.
                description:
                  type: string
                  x-stoplight:
                    id: ltip6sesrtqjx
                  description: >-
                    The description of the application associated with the
                    settings.
            hierarchyFields:
              type: object
              x-stoplight:
                id: z97e3l5m9o2e5
              properties:
                type:
                  type: string
                  x-stoplight:
                    id: tjyopqfbxy8ib
                  description: The type of setting for the hierarchical fields.
                  example: array
                title:
                  type: string
                  x-stoplight:
                    id: cgat1t74roih4
                  description: The title for the hierarchical fields.
                  example: Hierarchy fields
                description:
                  type: string
                  x-stoplight:
                    id: 2lzyk2xi7wfkj
                  description: The list of hierarchical fields for the schema.
                items:
                  type: object
                  x-stoplight:
                    id: 8hpxdutnjv1in
                  properties:
                    type:
                      type: string
                      x-stoplight:
                        id: 5fwdfsc7pqa2m
                      description: The type of hierarchical item.
                      example: object
                    properties:
                      type: object
                      x-stoplight:
                        id: zz1rvwanrfvq6
                      properties:
                        field:
                          type: object
                          x-stoplight:
                            id: m4q2931ez9b18
                          properties:
                            type:
                              type: string
                              x-stoplight:
                                id: cv8shi1jfllip
                              description: The type of field.
                            title:
                              type: string
                              x-stoplight:
                                id: 6noi4bh78bfko
                              description: The hierarchical field name.
                            description:
                              type: string
                              x-stoplight:
                                id: ytyn9zlsqelq6
                              description: The description of the hierarchical field.
                    separator:
                      type: object
                      x-stoplight:
                        id: mvqrwdb80kknf
                      description: >-
                        The character that separates each hierarchical field
                        specified for the template.
                      properties:
                        type:
                          type: string
                          x-stoplight:
                            id: g2cpipepm5qon
                          description: >-
                            The type of separator associated with the
                            hierarchical field.
                        title:
                          type: string
                          x-stoplight:
                            id: 58pw8jt8kmhl8
                          description: The name of the separator.
                        description:
                          type: string
                          x-stoplight:
                            id: w6nuei7aip9o3
                          description: The description of the separator character.
        category:
          type: string
          x-stoplight:
            id: a9re65rkhgbbm
          description: The category of the object in the schema.
        categoryPriority:
          type: string
          x-stoplight:
            id: uvrxhqx361le0
          description: The importance (priority) of the object in the schema.
        unsafe:
          type: boolean
          x-stoplight:
            id: pzzf7ggdzkvkq
          description: >-
            The security status of the objects in the schema. If `false`, the
            schema contents are valid. If `true`, the schema contents are not
            valid.

````